Module: PluralKitAPI

Defined in:
lib/pluralkit-api/version.rb,
lib/pluralkit-api.rb,
lib/pluralkit-api/api_error.rb,
lib/pluralkit-api/api_client.rb,
lib/pluralkit-api/configuration.rb,
lib/pluralkit-api/models/member.rb,
lib/pluralkit-api/models/switch.rb,
lib/pluralkit-api/models/system.rb,
lib/pluralkit-api/models/message.rb,
lib/pluralkit-api/api/members_api.rb,
lib/pluralkit-api/api/systems_api.rb,
lib/pluralkit-api/api/accounts_api.rb,
lib/pluralkit-api/api/proxying_api.rb,
lib/pluralkit-api/api/switches_api.rb,
lib/pluralkit-api/models/proxy_tag.rb,
lib/pluralkit-api/models/full_switch.rb,
lib/pluralkit-api/models/privacy_setting.rb

Overview

#PluralKit

#This is the API for [PluralKit](pluralkit.me/)! :) The API itself is stable, but this document (the OpenAPI description) is still subject to change, and may be updated, corrected or restructured in the future (as long as it’s still coherent with the real API). # Authentication Authentication is handled using a "system token". At the moment, the only way to obtain a system token is to use the ‘pk;token` command through the Discord bot. This will generate an opaque string you must pass as the `Authorization` header to API requests. Many API endpoints are available anonymously, but most of them will hide information from unauthenticated requests to align with the relevant privacy settings. # Errors Errors are just returned as HTTP response codes. Most error responses include a human-readable error message as the body, but this should not be relied on. Just read the response codes :) # OpenAPI version history - 1.1: Granular member privacy - 1.0: (initial definition version)

The version of the OpenAPI document: 1.1

Generated by: openapi-generator.tech OpenAPI Generator version: 5.2.0-SNAPSHOT

Defined Under Namespace

Classes: AccountsApi, ApiClient, ApiError, Configuration, FullSwitch, Member, MembersApi, Message, PrivacySetting, ProxyTag, ProxyingApi, Switch, SwitchesApi, System, SystemsApi

Constant Summary collapse

VERSION = 
'1.0.1'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

PluralKitAPI.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



43
44
45
46
47
48
49
 
# File 'lib/pluralkit-api.rb', line 43

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end