Class: OpenapiClient::InsuranceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InsuranceApi

Returns a new instance of InsuranceApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_funds_to_insurance(add_funds_to_insurance_request_body, opts = {}) ⇒ AddFundsToInsuranceResponseBody

Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don’t normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/openapi_client/api/insurance_api.rb', line 27

def add_funds_to_insurance(add_funds_to_insurance_request_body, opts = {})
  data, _status_code, _headers = add_funds_to_insurance_with_http_info(add_funds_to_insurance_request_body, opts)
  data
end

#add_funds_to_insurance_with_http_info(add_funds_to_insurance_request_body, opts = {}) ⇒ Array<(AddFundsToInsuranceResponseBody, Integer, Hash)>

Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don&#39;t normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.

Parameters:

Returns:



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

def add_funds_to_insurance_with_http_info(add_funds_to_insurance_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsuranceApi.add_funds_to_insurance ...'
  end
  # verify the required parameter 'add_funds_to_insurance_request_body' is set
  if @api_client.config.client_side_validation && add_funds_to_insurance_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'add_funds_to_insurance_request_body' when calling InsuranceApi.add_funds_to_insurance"
  end
  # resource path
  local_var_path = '/v1/insurance/shipsurance/add_funds'

  # 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(add_funds_to_insurance_request_body) 

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

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

#connect_insurer(connect_insurer_request_body, opts = {}) ⇒ Object

Connect a Shipsurance Account Connect a Shipsurance Account

Parameters:

Returns:

  • (Object) 


91
92
93
94
 
# File 'lib/openapi_client/api/insurance_api.rb', line 91

def connect_insurer(connect_insurer_request_body, opts = {})
  data, _status_code, _headers = connect_insurer_with_http_info(connect_insurer_request_body, opts)
  data
end

#connect_insurer_with_http_info(connect_insurer_request_body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Connect a Shipsurance Account Connect a Shipsurance Account

Parameters:

Returns:

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

    Object data, response status code and response headers



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
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/openapi_client/api/insurance_api.rb', line 101

def connect_insurer_with_http_info(connect_insurer_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsuranceApi.connect_insurer ...'
  end
  # verify the required parameter 'connect_insurer_request_body' is set
  if @api_client.config.client_side_validation && connect_insurer_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'connect_insurer_request_body' when calling InsuranceApi.connect_insurer"
  end
  # resource path
  local_var_path = '/v1/connections/insurance/shipsurance'

  # 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_insurer_request_body) 

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

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

#disconnect_insurer(opts = {}) ⇒ Object

Disconnect a Shipsurance Account Disconnect a Shipsurance Account

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


154
155
156
157
 
# File 'lib/openapi_client/api/insurance_api.rb', line 154

def disconnect_insurer(opts = {})
  data, _status_code, _headers = disconnect_insurer_with_http_info(opts)
  data
end

#disconnect_insurer_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Disconnect a Shipsurance Account Disconnect a Shipsurance Account

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
198
199
200
201
202
203
204
 
# File 'lib/openapi_client/api/insurance_api.rb', line 163

def disconnect_insurer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsuranceApi.disconnect_insurer ...'
  end
  # resource path
  local_var_path = '/v1/connections/insurance/shipsurance'

  # 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] || 'Object' 

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

#get_insurance_balance(opts = {}) ⇒ GetInsuranceBalanceResponseBody

Get Insurance Funds Balance Retrieve the balance of your Shipsurance account.

Parameters:

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/openapi_client/api/insurance_api.rb', line 210

def get_insurance_balance(opts = {})
  data, _status_code, _headers = get_insurance_balance_with_http_info(opts)
  data
end

#get_insurance_balance_with_http_info(opts = {}) ⇒ Array<(GetInsuranceBalanceResponseBody, Integer, Hash)>

Get Insurance Funds Balance Retrieve the balance of your Shipsurance account.

Parameters:

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

    the optional parameters

Returns:



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
253
254
255
256
257
258
259
260
 
# File 'lib/openapi_client/api/insurance_api.rb', line 219

def get_insurance_balance_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsuranceApi.get_insurance_balance ...'
  end
  # resource path
  local_var_path = '/v1/insurance/shipsurance/balance'

  # 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] || 'GetInsuranceBalanceResponseBody' 

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