Class: ClickSendClient::ResellerAccountApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResellerAccountApi

Returns a new instance of ResellerAccountApi.



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

def api_client
  @api_client
end

Instance Method Details

#reseller_accounts_by_client_user_id_get(client_user_id, opts = {}) ⇒ String

Get Reseller clients Account Get Reseller clients Account

Parameters:

  • client_user_id —

    User ID of client

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

    the optional parameters

Returns:

  • (String) 


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

def reseller_accounts_by_client_user_id_get(client_user_id, opts = {})
  data, _status_code, _headers = reseller_accounts_by_client_user_id_get_with_http_info(client_user_id, opts)
  data
end

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

Get Reseller clients Account Get Reseller clients Account

Parameters:

  • client_user_id —

    User ID of client

  • 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/reseller_account_api.rb', line 37

def reseller_accounts_by_client_user_id_get_with_http_info(client_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResellerAccountApi.reseller_accounts_by_client_user_id_get ...'
  end
  # verify the required parameter 'client_user_id' is set
  if @api_client.config.client_side_validation && client_user_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_user_id' when calling ResellerAccountApi.reseller_accounts_by_client_user_id_get"
  end
  # resource path
  local_var_path = '/reseller/accounts/{client_user_id}'.sub('{' + 'client_user_id' + '}', client_user_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: ResellerAccountApi#reseller_accounts_by_client_user_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reseller_accounts_by_client_user_id_put(client_user_id, reseller_account, opts = {}) ⇒ String

Update Reseller clients Account Update Reseller clients Account

Parameters:

  • client_user_id —

    User ID of client

  • reseller_account —

    ResellerAccount model

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

    the optional parameters

Returns:

  • (String) 


82
83
84
85
 
# File 'lib/clicksend_client/api/reseller_account_api.rb', line 82

def reseller_accounts_by_client_user_id_put(client_user_id, , opts = {})
  data, _status_code, _headers = reseller_accounts_by_client_user_id_put_with_http_info(client_user_id, , opts)
  data
end

#reseller_accounts_by_client_user_id_put_with_http_info(client_user_id, reseller_account, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update Reseller clients Account Update Reseller clients Account

Parameters:

  • client_user_id —

    User ID of client

  • reseller_account —

    ResellerAccount model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
130
131
132
133
134
135
 
# File 'lib/clicksend_client/api/reseller_account_api.rb', line 93

def reseller_accounts_by_client_user_id_put_with_http_info(client_user_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResellerAccountApi.reseller_accounts_by_client_user_id_put ...'
  end
  # verify the required parameter 'client_user_id' is set
  if @api_client.config.client_side_validation && client_user_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_user_id' when calling ResellerAccountApi.reseller_accounts_by_client_user_id_put"
  end
  # verify the required parameter 'reseller_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'reseller_account' when calling ResellerAccountApi.reseller_accounts_by_client_user_id_put"
  end
  # resource path
  local_var_path = '/reseller/accounts/{client_user_id}'.sub('{' + 'client_user_id' + '}', client_user_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()
  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: ResellerAccountApi#reseller_accounts_by_client_user_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reseller_accounts_get(opts = {}) ⇒ String

Get list of reseller accounts Get list of reseller accounts

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) 


142
143
144
145
 
# File 'lib/clicksend_client/api/reseller_account_api.rb', line 142

def reseller_accounts_get(opts = {})
  data, _status_code, _headers = reseller_accounts_get_with_http_info(opts)
  data
end

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

Get list of reseller accounts Get list of reseller accounts

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



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
190
191
192
193
194
195
196
197
 
# File 'lib/clicksend_client/api/reseller_account_api.rb', line 153

def reseller_accounts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResellerAccountApi.reseller_accounts_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ResellerAccountApi.reseller_accounts_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 ResellerAccountApi.reseller_accounts_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/reseller/accounts'

  # 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: ResellerAccountApi#reseller_accounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reseller_accounts_post(reseller_account, opts = {}) ⇒ String

Create reseller account Create reseller account

Parameters:

  • reseller_account —

    ResellerAccount model

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

    the optional parameters

Returns:

  • (String) 


203
204
205
206
 
# File 'lib/clicksend_client/api/reseller_account_api.rb', line 203

def reseller_accounts_post(, opts = {})
  data, _status_code, _headers = reseller_accounts_post_with_http_info(, opts)
  data
end

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

Create reseller account Create reseller account

Parameters:

  • reseller_account —

    ResellerAccount model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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/reseller_account_api.rb', line 213

def reseller_accounts_post_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResellerAccountApi.reseller_accounts_post ...'
  end
  # verify the required parameter 'reseller_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'reseller_account' when calling ResellerAccountApi.reseller_accounts_post"
  end
  # resource path
  local_var_path = '/reseller/accounts'

  # 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()
  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: ResellerAccountApi#reseller_accounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end