Class: PluralKitAPI::AccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pluralkit-api/api/accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



19
20
21
 
# File 'lib/pluralkit-api/api/accounts_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pluralkit-api/api/accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#a_id_get(id, opts = {}) ⇒ System

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".

Parameters:

  • id (String) —

    A Discord user ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/pluralkit-api/api/accounts_api.rb', line 27

def a_id_get(id, opts = {})
  data, _status_code, _headers = a_id_get_with_http_info(id, opts)
  data
end

#a_id_get_with_http_info(id, opts = {}) ⇒ Array<(System, Integer, Hash)>

Gets a system by (one of) its associated Discord accounts. Note that it&#39;s currently not possible to get a system&#39;s registered accounts given a system ID through the API. Consider this endpoint &quot;one-way&quot;.

Parameters:

  • id (String) —

    A Discord user ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(System, Integer, Hash)>) —

    System data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/pluralkit-api/api/accounts_api.rb', line 37

def a_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.a_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.a_id_get"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 19
    fail ArgumentError, 'invalid value for "id" when calling AccountsApi.a_id_get, the character length must be smaller than or equal to 19.'
  end

  if @api_client.config.client_side_validation && id.to_s.length < 17
    fail ArgumentError, 'invalid value for "id" when calling AccountsApi.a_id_get, the character length must be great than or equal to 17.'
  end

  pattern = Regexp.new(/^[0-9]{17,19}/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling AccountsApi.a_id_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/a/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'System'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AccountsApi.a_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#a_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end