Class: OpenapiClient::CarrierAccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/carrier_accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CarrierAccountsApi

Returns a new instance of CarrierAccountsApi.



19
20
21
 
# File 'lib/openapi_client/api/carrier_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/openapi_client/api/carrier_accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#connect_carrier(carrier_name, connect_carrier_request_body, opts = {}) ⇒ ConnectCarrierResponseBody

Connect a carrier account Connect a carrier account

Parameters:

  • carrier_name (CarrierName) —

    The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 28

def connect_carrier(carrier_name, connect_carrier_request_body, opts = {})
  data, _status_code, _headers = connect_carrier_with_http_info(carrier_name, connect_carrier_request_body, opts)
  data
end

#connect_carrier_with_http_info(carrier_name, connect_carrier_request_body, opts = {}) ⇒ Array<(ConnectCarrierResponseBody, Integer, Hash)>

Connect a carrier account Connect a carrier account

Parameters:

  • carrier_name (CarrierName) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

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

    the optional parameters

Returns:

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

    ConnectCarrierResponseBody data, response status code and response headers



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
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 39

def connect_carrier_with_http_info(carrier_name, connect_carrier_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CarrierAccountsApi.connect_carrier ...'
  end
  # verify the required parameter 'carrier_name' is set
  if @api_client.config.client_side_validation && carrier_name.nil?
    fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.connect_carrier"
  end
  # verify the required parameter 'connect_carrier_request_body' is set
  if @api_client.config.client_side_validation && connect_carrier_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'connect_carrier_request_body' when calling CarrierAccountsApi.connect_carrier"
  end
  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.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'])
  # 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[:body] || @api_client.object_to_http_body(connect_carrier_request_body) 

  # return_type
  return_type = opts[:return_type] || 'ConnectCarrierResponseBody' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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

#disconnect_carrier(carrier_name, carrier_id, opts = {}) ⇒ String

Disconnect a carrier Disconnect a carrier

Parameters:

  • carrier_name (CarrierName) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

  • carrier_id (String) —

    Carrier ID

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

    the optional parameters

Returns:

  • (String) 


98
99
100
101
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 98

def disconnect_carrier(carrier_name, carrier_id, opts = {})
  data, _status_code, _headers = disconnect_carrier_with_http_info(carrier_name, carrier_id, opts)
  data
end

#disconnect_carrier_with_http_info(carrier_name, carrier_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Disconnect a carrier Disconnect a carrier

Parameters:

  • carrier_name (CarrierName) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

  • carrier_id (String) —

    Carrier ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
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
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 109

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

  if @api_client.config.client_side_validation && carrier_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "carrier_id" when calling CarrierAccountsApi.disconnect_carrier, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
  if @api_client.config.client_side_validation && carrier_id !~ pattern
    fail ArgumentError, "invalid value for 'carrier_id' when calling CarrierAccountsApi.disconnect_carrier, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_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(['text/plain', 'application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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

#get_carrier_settings(carrier_name, carrier_id, opts = {}) ⇒ GetCarrierSettingsResponseBody

Get carrier settings Get carrier settings

Parameters:

  • carrier_name (CarrierNameWithSettings) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

  • carrier_id (String) —

    Carrier ID

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 179

def get_carrier_settings(carrier_name, carrier_id, opts = {})
  data, _status_code, _headers = get_carrier_settings_with_http_info(carrier_name, carrier_id, opts)
  data
end

#get_carrier_settings_with_http_info(carrier_name, carrier_id, opts = {}) ⇒ Array<(GetCarrierSettingsResponseBody, Integer, Hash)>

Get carrier settings Get carrier settings

Parameters:

  • carrier_name (CarrierNameWithSettings) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

  • carrier_id (String) —

    Carrier ID

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

    the optional parameters

Returns:



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

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

  if @api_client.config.client_side_validation && carrier_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "carrier_id" when calling CarrierAccountsApi.get_carrier_settings, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
  if @api_client.config.client_side_validation && carrier_id !~ pattern
    fail ArgumentError, "invalid value for 'carrier_id' when calling CarrierAccountsApi.get_carrier_settings, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}/settings'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'GetCarrierSettingsResponseBody' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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

#update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body, opts = {}) ⇒ String

Update carrier settings Update carrier settings

Parameters:

  • carrier_name (CarrierNameWithSettings) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

  • carrier_id (String) —

    Carrier ID

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

    the optional parameters

Returns:

  • (String) 


261
262
263
264
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 261

def update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body, opts = {})
  data, _status_code, _headers = update_carrier_settings_with_http_info(carrier_name, carrier_id, update_carrier_settings_request_body, opts)
  data
end

#update_carrier_settings_with_http_info(carrier_name, carrier_id, update_carrier_settings_request_body, opts = {}) ⇒ Array<(String, Integer, Hash)>

Update carrier settings Update carrier settings

Parameters:

  • carrier_name (CarrierNameWithSettings) —

    The carrier name, such as &#x60;stamps_com&#x60;, &#x60;ups&#x60;, &#x60;fedex&#x60;, or &#x60;dhl_express&#x60;.

  • carrier_id (String) —

    Carrier ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/openapi_client/api/carrier_accounts_api.rb', line 273

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

  if @api_client.config.client_side_validation && carrier_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "carrier_id" when calling CarrierAccountsApi.update_carrier_settings, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
  if @api_client.config.client_side_validation && carrier_id !~ pattern
    fail ArgumentError, "invalid value for 'carrier_id' when calling CarrierAccountsApi.update_carrier_settings, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'update_carrier_settings_request_body' is set
  if @api_client.config.client_side_validation && update_carrier_settings_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_carrier_settings_request_body' when calling CarrierAccountsApi.update_carrier_settings"
  end
  # resource path
  local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}/settings'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_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(['text/plain', 'application/json'])
  # 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[:body] || @api_client.object_to_http_body(update_carrier_settings_request_body) 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

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