Class: PluralKitAPI::SwitchesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SwitchesApi

Returns a new instance of SwitchesApi.



19
20
21
 
# File 'lib/pluralkit-api/api/switches_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/switches_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_system_fronters(id, opts = {}) ⇒ FullSwitch

Gets a system’s current fronters.

Parameters:

  • id (String) —

    The ID of the system in question.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pluralkit-api/api/switches_api.rb', line 26

def get_system_fronters(id, opts = {})
  data, _status_code, _headers = get_system_fronters_with_http_info(id, opts)
  data
end

#get_system_fronters_with_http_info(id, opts = {}) ⇒ Array<(FullSwitch, Integer, Hash)>

Gets a system&#39;s current fronters.

Parameters:

  • id (String) —

    The ID of the system in question.

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

    the optional parameters

Returns:

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

    FullSwitch data, response status code and response headers



35
36
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
 
# File 'lib/pluralkit-api/api/switches_api.rb', line 35

def get_system_fronters_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchesApi.get_system_fronters ...'
  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 SwitchesApi.get_system_fronters"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 5
    fail ArgumentError, 'invalid value for "id" when calling SwitchesApi.get_system_fronters, the character length must be smaller than or equal to 5.'
  end

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

  pattern = Regexp.new(/^[a-z]{5}$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling SwitchesApi.get_system_fronters, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/s/{id}/fronters'.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] || 'FullSwitch'

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

  new_options = opts.merge(
    :operation => :"SwitchesApi.get_system_fronters",
    :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: SwitchesApi#get_system_fronters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_system_switches(id, opts = {}) ⇒ Array<Switch>

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.

Parameters:

  • id (String) —

    The ID of the system in question.

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:



102
103
104
105
 
# File 'lib/pluralkit-api/api/switches_api.rb', line 102

def get_system_switches(id, opts = {})
  data, _status_code, _headers = get_system_switches_with_http_info(id, opts)
  data
end

#get_system_switches_with_http_info(id, opts = {}) ⇒ Array<(Array<Switch>, Integer, Hash)>

Gets a system&#39;s switch history. Will return the system&#39;s switch history, up to 100 entries at a time, in reverse-chronological (latest first) order. For pagination, see the &#x60;before&#x60; query parameter.

Parameters:

  • id (String) —

    The ID of the system in question.

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

    the optional parameters

Options Hash (opts):

  • :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.

Returns:

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

    Array<Switch> data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/pluralkit-api/api/switches_api.rb', line 113

def get_system_switches_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchesApi.get_system_switches ...'
  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 SwitchesApi.get_system_switches"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 5
    fail ArgumentError, 'invalid value for "id" when calling SwitchesApi.get_system_switches, the character length must be smaller than or equal to 5.'
  end

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

  pattern = Regexp.new(/^[a-z]{5}$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling SwitchesApi.get_system_switches, must conform to the pattern #{pattern}."
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

  # 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] || 'Array<Switch>'

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

  new_options = opts.merge(
    :operation => :"SwitchesApi.get_system_switches",
    :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: SwitchesApi#get_system_switches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#register_switch(switch, opts = {}) ⇒ nil

Registers a new switch.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


179
180
181
182
 
# File 'lib/pluralkit-api/api/switches_api.rb', line 179

def register_switch(switch, opts = {})
  register_switch_with_http_info(switch, opts)
  nil
end

#register_switch_with_http_info(switch, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Registers a new switch.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/pluralkit-api/api/switches_api.rb', line 188

def register_switch_with_http_info(switch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SwitchesApi.register_switch ...'
  end
  # verify the required parameter 'switch' is set
  if @api_client.config.client_side_validation && switch.nil?
    fail ArgumentError, "Missing the required parameter 'switch' when calling SwitchesApi.register_switch"
  end
  # resource path
  local_var_path = '/s/switches'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(switch)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"SwitchesApi.register_switch",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SwitchesApi#register_switch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end