pluralkit-api 1.0.0

data/docs/Message.md

@@ -0,0 +1,30 @@
+# PluralKitAPI::Message
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Time** | The time the message was proxied. | [optional][readonly] |
+| **id** | **String** |  | [optional] |
+| **original** | **String** |  | [optional] |
+| **sender** | **String** |  | [optional] |
+| **channel** | **String** |  | [optional] |
+| **system** | [**System**](System.md) |  | [optional] |
+| **member** | [**Member**](Member.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pluralkit-api'
+
+instance = PluralKitAPI::Message.new(
+  timestamp: null,
+  id: null,
+  original: null,
+  sender: null,
+  channel: null,
+  system: null,
+  member: null
+)
+```
+

data/docs/PrivacySetting.md

@@ -0,0 +1,15 @@
+# PluralKitAPI::PrivacySetting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pluralkit-api'
+
+instance = PluralKitAPI::PrivacySetting.new()
+```
+

data/docs/ProxyTag.md

@@ -0,0 +1,20 @@
+# PluralKitAPI::ProxyTag
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prefix** | **String** | The proxy tag prefix. This is the string that goes *before* the inner text.  An empty prefix is represented as `null` and an empty string will be converted as such.  | [optional] |
+| **suffix** | **String** | The proxy tag suffix. This is the string that goes *after* the inner text.  An empty suffix is represented as `null` and an empty string will be converted as such.  | [optional] |
+
+## Example
+
+```ruby
+require 'pluralkit-api'
+
+instance = PluralKitAPI::ProxyTag.new(
+  prefix: {{,
+  suffix: }}
+)
+```
+

data/docs/ProxyingApi.md

@@ -0,0 +1,70 @@
+# PluralKitAPI::ProxyingApi
+
+All URIs are relative to *https://api.pluralkit.me/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**msg_id_get**](ProxyingApi.md#msg_id_get) | **GET** /msg/{id} | Gets information about a proxied message by its message ID. |
+
+
+## msg_id_get
+
+> <Message> msg_id_get(id)
+
+Gets information about a proxied message by its message ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::ProxyingApi.new
+id = 'id_example' # String | A Discord message ID.  This may refer to either the original \"trigger message\" posted by the user, or to the resulting webhook message posted by PluralKit. The former may be useful for eg. logging bot integration. 
+
+begin
+  # Gets information about a proxied message by its message ID.
+  result = api_instance.msg_id_get(id)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling ProxyingApi->msg_id_get: #{e}"
+end
+```
+
+#### Using the msg_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Message>, Integer, Hash)> msg_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Gets information about a proxied message by its message ID.
+  data, status_code, headers = api_instance.msg_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Message>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling ProxyingApi->msg_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A Discord message ID.  This may refer to either the original \&quot;trigger message\&quot; posted by the user, or to the resulting webhook message posted by PluralKit. The former may be useful for eg. logging bot integration.  |  |
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Switch.md

@@ -0,0 +1,20 @@
+# PluralKitAPI::Switch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Time** | The timestamp the switch was logged. | [optional][readonly] |
+| **members** | **Array<String>** | A list of the IDs of the members in this switch. The order is significant. It is valid for the switch to have no members at all.  | [optional] |
+
+## Example
+
+```ruby
+require 'pluralkit-api'
+
+instance = PluralKitAPI::Switch.new(
+  timestamp: null,
+  members: null
+)
+```
+

data/docs/SwitchesApi.md

@@ -0,0 +1,208 @@
+# PluralKitAPI::SwitchesApi
+
+All URIs are relative to *https://api.pluralkit.me/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_system_fronters**](SwitchesApi.md#get_system_fronters) | **GET** /s/{id}/fronters | Gets a system's current fronters. |
+| [**get_system_switches**](SwitchesApi.md#get_system_switches) | **GET** /s/{id}/switches | Gets a system's switch history. |
+| [**register_switch**](SwitchesApi.md#register_switch) | **POST** /s/switches | Registers a new switch. |
+
+
+## get_system_fronters
+
+> <FullSwitch> get_system_fronters(id)
+
+Gets a system's current fronters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SwitchesApi.new
+id = 'id_example' # String | The ID of the system in question.
+
+begin
+  # Gets a system's current fronters.
+  result = api_instance.get_system_fronters(id)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SwitchesApi->get_system_fronters: #{e}"
+end
+```
+
+#### Using the get_system_fronters_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FullSwitch>, Integer, Hash)> get_system_fronters_with_http_info(id)
+
+```ruby
+begin
+  # Gets a system's current fronters.
+  data, status_code, headers = api_instance.get_system_fronters_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FullSwitch>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SwitchesApi->get_system_fronters_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the system in question. |  |
+
+### Return type
+
+[**FullSwitch**](FullSwitch.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_system_switches
+
+> <Array<Switch>> get_system_switches(id, opts)
+
+Gets a system's switch history.
+
+Will return the system's switch history, up to 100 entries at a time, in reverse-chronological (latest first) order.  For pagination, see the `before` query parameter. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SwitchesApi.new
+id = 'id_example' # String | The ID of the system in question.
+opts = {
+  before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return switches that happened *before* (and not including) this timestamp.  This can be used for pagination by calling the endpoint again with the timestamp of the last switch of the previous response. 
+}
+
+begin
+  # Gets a system's switch history.
+  result = api_instance.get_system_switches(id, opts)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SwitchesApi->get_system_switches: #{e}"
+end
+```
+
+#### Using the get_system_switches_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Switch>>, Integer, Hash)> get_system_switches_with_http_info(id, opts)
+
+```ruby
+begin
+  # Gets a system's switch history.
+  data, status_code, headers = api_instance.get_system_switches_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Switch>>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SwitchesApi->get_system_switches_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the system in question. |  |
+| **before** | **Time** | If provided, will only return switches that happened *before* (and not including) this timestamp.  This can be used for pagination by calling the endpoint again with the timestamp of the last switch of the previous response.  | [optional] |
+
+### Return type
+
+[**Array&lt;Switch&gt;**](Switch.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## register_switch
+
+> register_switch(switch)
+
+Registers a new switch.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+# setup authorization
+PluralKitAPI.configure do |config|
+  # Configure API key authorization: TokenAuth
+  config.api_key['TokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['TokenAuth'] = 'Bearer'
+end
+
+api_instance = PluralKitAPI::SwitchesApi.new
+switch = PluralKitAPI::Switch.new # Switch | 
+
+begin
+  # Registers a new switch.
+  api_instance.register_switch(switch)
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SwitchesApi->register_switch: #{e}"
+end
+```
+
+#### Using the register_switch_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> register_switch_with_http_info(switch)
+
+```ruby
+begin
+  # Registers a new switch.
+  data, status_code, headers = api_instance.register_switch_with_http_info(switch)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SwitchesApi->register_switch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **switch** | [**Switch**](Switch.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/System.md

@@ -0,0 +1,40 @@
+# PluralKitAPI::System
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for a system or a member, as a randomly generated string of five lowercase letters.  These IDs are guaranteed to be globally unique for the given model type (a system can have the same ID as a member, but two systems or two members can never share an ID).  The IDs can on rare occasions change - eg. if a profane word is generated and later regenerated, or as a potential future Patreon perk. However, it's still reasonable to assume that the IDs are constant, and that tey won't change without the user's knowledge, so it's safe to store in things like settings menus and config files.  | [optional][readonly] |
+| **name** | **String** | The user-provided name of the system. | [optional] |
+| **description** | **String** | The user-provided system description.  May contain rich text in Markdown, including standard Markdown-formatted links, or Discord-formatted emoji/user/channel references.  | [optional] |
+| **tag** | **String** | The system tag, which is appended to the names (or display names, if set) of members when proxying through the bot.  A space will automatically be inserted between the name and the tag, so no need to include one at the start.  The character limit here is 78, as Discord's name length limit for webhooks is 80 characters. A 78-character system tag is thus the longest tag that can still accomodate a single-letter member name and the separating space.  | [optional] |
+| **avatar_url** | **String** | A link to the avatar/icon of the system.  If used for proxying, the image must be at most 1000 pixels in width *and* height, and at most 1 MiB in size. This restriction is on Discord's end and is not verified through the API (it's simply stored as a string).  | [optional] |
+| **tz** | **String** | The system's registered time zone as an Olson time zone ID.  This is used in the bot to convert various time stamps in commands on behalf of this system.  | [optional][default to 'UTC'] |
+| **created** | **Time** | The creation timestamp of the system. | [optional][readonly] |
+| **description_privacy** | [**PrivacySetting**](PrivacySetting.md) |  | [optional] |
+| **member_list_privacy** | [**PrivacySetting**](PrivacySetting.md) |  | [optional] |
+| **front_privacy** | [**PrivacySetting**](PrivacySetting.md) |  | [optional] |
+| **front_history_privacy** | [**PrivacySetting**](PrivacySetting.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pluralkit-api'
+
+instance = PluralKitAPI::System.new(
+  id: abcde,
+  name: Boxes of Foxes,
+  description: This system is very cool.
+
+It has cool people.,
+  tag: | BoF,
+  avatar_url: https://i.imgur.com/Abcdefg.png,
+  tz: America/New_York,
+  created: null,
+  description_privacy: null,
+  member_list_privacy: null,
+  front_privacy: null,
+  front_history_privacy: null
+)
+```
+

data/docs/SystemsApi.md

@@ -0,0 +1,475 @@
+# PluralKitAPI::SystemsApi
+
+All URIs are relative to *https://api.pluralkit.me/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**a_id_get**](SystemsApi.md#a_id_get) | **GET** /a/{id} | Gets a system by (one of) its associated Discord accounts. |
+| [**get_own_system**](SystemsApi.md#get_own_system) | **GET** /s | Returns your own system. |
+| [**get_system**](SystemsApi.md#get_system) | **GET** /s/{id} | Gets a system by its ID. |
+| [**get_system_fronters**](SystemsApi.md#get_system_fronters) | **GET** /s/{id}/fronters | Gets a system's current fronters. |
+| [**get_system_members**](SystemsApi.md#get_system_members) | **GET** /s/{id}/members | Gets a system's members. |
+| [**get_system_switches**](SystemsApi.md#get_system_switches) | **GET** /s/{id}/switches | Gets a system's switch history. |
+| [**update_system**](SystemsApi.md#update_system) | **PATCH** /s | Updates an existing system. |
+
+
+## a_id_get
+
+> <System> a_id_get(id)
+
+Gets a system by (one of) its associated Discord accounts.
+
+Note that it's currently not possible to get a system's registered accounts given a system ID through the API. Consider this endpoint \"one-way\". 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SystemsApi.new
+id = 'id_example' # String | A Discord user ID.
+
+begin
+  # Gets a system by (one of) its associated Discord accounts.
+  result = api_instance.a_id_get(id)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->a_id_get: #{e}"
+end
+```
+
+#### Using the a_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<System>, Integer, Hash)> a_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Gets a system by (one of) its associated Discord accounts.
+  data, status_code, headers = api_instance.a_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <System>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->a_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A Discord user ID. |  |
+
+### Return type
+
+[**System**](System.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_own_system
+
+> <System> get_own_system
+
+Returns your own system.
+
+Requires authentication, and will returns the system the token belongs to.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+# setup authorization
+PluralKitAPI.configure do |config|
+  # Configure API key authorization: TokenAuth
+  config.api_key['TokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['TokenAuth'] = 'Bearer'
+end
+
+api_instance = PluralKitAPI::SystemsApi.new
+
+begin
+  # Returns your own system.
+  result = api_instance.get_own_system
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_own_system: #{e}"
+end
+```
+
+#### Using the get_own_system_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<System>, Integer, Hash)> get_own_system_with_http_info
+
+```ruby
+begin
+  # Returns your own system.
+  data, status_code, headers = api_instance.get_own_system_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <System>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_own_system_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**System**](System.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_system
+
+> <System> get_system(id)
+
+Gets a system by its ID.
+
+Partial information may be returned if not authenticated with this system's token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SystemsApi.new
+id = 'id_example' # String | The ID of the system in question.
+
+begin
+  # Gets a system by its ID.
+  result = api_instance.get_system(id)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system: #{e}"
+end
+```
+
+#### Using the get_system_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<System>, Integer, Hash)> get_system_with_http_info(id)
+
+```ruby
+begin
+  # Gets a system by its ID.
+  data, status_code, headers = api_instance.get_system_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <System>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the system in question. |  |
+
+### Return type
+
+[**System**](System.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_system_fronters
+
+> <FullSwitch> get_system_fronters(id)
+
+Gets a system's current fronters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SystemsApi.new
+id = 'id_example' # String | The ID of the system in question.
+
+begin
+  # Gets a system's current fronters.
+  result = api_instance.get_system_fronters(id)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_fronters: #{e}"
+end
+```
+
+#### Using the get_system_fronters_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FullSwitch>, Integer, Hash)> get_system_fronters_with_http_info(id)
+
+```ruby
+begin
+  # Gets a system's current fronters.
+  data, status_code, headers = api_instance.get_system_fronters_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FullSwitch>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_fronters_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the system in question. |  |
+
+### Return type
+
+[**FullSwitch**](FullSwitch.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_system_members
+
+> <Array<System>> get_system_members(id)
+
+Gets a system's members.
+
+If the API token does not belong to this system, this list may exclude any private members in the system. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SystemsApi.new
+id = 'id_example' # String | The ID of the system in question.
+
+begin
+  # Gets a system's members.
+  result = api_instance.get_system_members(id)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_members: #{e}"
+end
+```
+
+#### Using the get_system_members_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<System>>, Integer, Hash)> get_system_members_with_http_info(id)
+
+```ruby
+begin
+  # Gets a system's members.
+  data, status_code, headers = api_instance.get_system_members_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<System>>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_members_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the system in question. |  |
+
+### Return type
+
+[**Array&lt;System&gt;**](System.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_system_switches
+
+> <Array<Switch>> get_system_switches(id, opts)
+
+Gets a system's switch history.
+
+Will return the system's switch history, up to 100 entries at a time, in reverse-chronological (latest first) order.  For pagination, see the `before` query parameter. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+
+api_instance = PluralKitAPI::SystemsApi.new
+id = 'id_example' # String | The ID of the system in question.
+opts = {
+  before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return switches that happened *before* (and not including) this timestamp.  This can be used for pagination by calling the endpoint again with the timestamp of the last switch of the previous response. 
+}
+
+begin
+  # Gets a system's switch history.
+  result = api_instance.get_system_switches(id, opts)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_switches: #{e}"
+end
+```
+
+#### Using the get_system_switches_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Switch>>, Integer, Hash)> get_system_switches_with_http_info(id, opts)
+
+```ruby
+begin
+  # Gets a system's switch history.
+  data, status_code, headers = api_instance.get_system_switches_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Switch>>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->get_system_switches_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the system in question. |  |
+| **before** | **Time** | If provided, will only return switches that happened *before* (and not including) this timestamp.  This can be used for pagination by calling the endpoint again with the timestamp of the last switch of the previous response.  | [optional] |
+
+### Return type
+
+[**Array&lt;Switch&gt;**](Switch.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_system
+
+> <System> update_system(system)
+
+Updates an existing system.
+
+Requires authentication, and will update the system the token belongs to.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pluralkit-api'
+# setup authorization
+PluralKitAPI.configure do |config|
+  # Configure API key authorization: TokenAuth
+  config.api_key['TokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['TokenAuth'] = 'Bearer'
+end
+
+api_instance = PluralKitAPI::SystemsApi.new
+system = PluralKitAPI::System.new # System | 
+
+begin
+  # Updates an existing system.
+  result = api_instance.update_system(system)
+  p result
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->update_system: #{e}"
+end
+```
+
+#### Using the update_system_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<System>, Integer, Hash)> update_system_with_http_info(system)
+
+```ruby
+begin
+  # Updates an existing system.
+  data, status_code, headers = api_instance.update_system_with_http_info(system)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <System>
+rescue PluralKitAPI::ApiError => e
+  puts "Error when calling SystemsApi->update_system_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **system** | [**System**](System.md) |  |  |
+
+### Return type
+
+[**System**](System.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+