Class: ClickSendClient::SubaccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/subaccount_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubaccountApi

Returns a new instance of SubaccountApi.



19
20
21
 
# File 'lib/clicksend_client/api/subaccount_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/clicksend_client/api/subaccount_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#subaccounts_by_subaccount_id_delete(subaccount_id, opts = {}) ⇒ String

Delete a subaccount Delete a subaccount

Parameters:

  • subaccount_id —

    ID of subaccount to delete

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 27

def subaccounts_by_subaccount_id_delete(subaccount_id, opts = {})
  data, _status_code, _headers = subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts)
  data
end

#subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a subaccount Delete a subaccount

Parameters:

  • subaccount_id —

    ID of subaccount to delete

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String 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
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 37

def subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_delete ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_delete"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_by_subaccount_id_get(subaccount_id, opts = {}) ⇒ String

Get specific subaccount Get specific subaccount

Parameters:

  • subaccount_id —

    ID of subaccount to get

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

    the optional parameters

Returns:

  • (String) 


81
82
83
84
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 81

def subaccounts_by_subaccount_id_get(subaccount_id, opts = {})
  data, _status_code, _headers = subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts)
  data
end

#subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific subaccount Get specific subaccount

Parameters:

  • subaccount_id —

    ID of subaccount to get

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 91

def subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_get ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_get"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_by_subaccount_id_put(subaccount_id, subaccount, opts = {}) ⇒ String

Update subaccount Update subaccount

Parameters:

  • subaccount_id —

    ID of subaccount to update

  • subaccount —

    Subaccount model

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

    the optional parameters

Returns:

  • (String) 


136
137
138
139
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 136

def subaccounts_by_subaccount_id_put(subaccount_id, subaccount, opts = {})
  data, _status_code, _headers = subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts)
  data
end

#subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update subaccount Update subaccount

Parameters:

  • subaccount_id —

    ID of subaccount to update

  • subaccount —

    Subaccount model

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 147

def subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_put ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_put"
  end
  # verify the required parameter 'subaccount' is set
  if @api_client.config.client_side_validation && subaccount.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount' when calling SubaccountApi.subaccounts_by_subaccount_id_put"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(subaccount)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_get(opts = {}) ⇒ String

Get all subaccounts Get all subaccounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


196
197
198
199
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 196

def subaccounts_get(opts = {})
  data, _status_code, _headers = subaccounts_get_with_http_info(opts)
  data
end

#subaccounts_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all subaccounts Get all subaccounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 207

def subaccounts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SubaccountApi.subaccounts_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubaccountApi.subaccounts_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/subaccounts'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_post(subaccount, opts = {}) ⇒ String

Create new subaccount Create new subaccount

Parameters:

  • subaccount —

    Subaccount model

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

    the optional parameters

Returns:

  • (String) 


257
258
259
260
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 257

def subaccounts_post(subaccount, opts = {})
  data, _status_code, _headers = subaccounts_post_with_http_info(subaccount, opts)
  data
end

#subaccounts_post_with_http_info(subaccount, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Create new subaccount Create new subaccount

Parameters:

  • subaccount —

    Subaccount model

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 267

def subaccounts_post_with_http_info(subaccount, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_post ...'
  end
  # verify the required parameter 'subaccount' is set
  if @api_client.config.client_side_validation && subaccount.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount' when calling SubaccountApi.subaccounts_post"
  end
  # resource path
  local_var_path = '/subaccounts'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(subaccount)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id, opts = {}) ⇒ String

Regenerate an API Key Regenerate an API Key

Parameters:

  • subaccount_id —

    ID of subaccount to regenerate API key for

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

    the optional parameters

Returns:

  • (String) 


311
312
313
314
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 311

def subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id, opts = {})
  data, _status_code, _headers = subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts)
  data
end

#subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Regenerate an API Key Regenerate an API Key

Parameters:

  • subaccount_id —

    ID of subaccount to regenerate API key for

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/clicksend_client/api/subaccount_api.rb', line 321

def subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_regen_api_key_by_subaccount_id_put ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_regen_api_key_by_subaccount_id_put"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}/regen-api-key'.sub('{' + 'subaccount_id' + '}', subaccount_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_regen_api_key_by_subaccount_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end