Class: PolarAccesslinkApiGem::PhysicalInfoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/polar-accesslink-api-gem/api/physical_info_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PhysicalInfoApi

Returns a new instance of PhysicalInfoApi.



19
20
21
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_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/polar-accesslink-api-gem/api/physical_info_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#commit_physical_info_transaction(transaction_id, user_id, opts = {}) ⇒ nil

Commit transaction After successfully retrieving physical information within a transaction, partners are expected to commit the transaction.

Parameters:

  • transaction_id (Integer) —

    Transaction identifier

  • user_id (Integer) —

    User identifier

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 28

def commit_physical_info_transaction(transaction_id, user_id, opts = {})
  commit_physical_info_transaction_with_http_info(transaction_id, user_id, opts)
  nil
end

#commit_physical_info_transaction_with_http_info(transaction_id, user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Commit transaction After successfully retrieving physical information within a transaction, partners are expected to commit the transaction.

Parameters:

  • transaction_id (Integer) —

    Transaction identifier

  • user_id (Integer) —

    User identifier

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 39

def commit_physical_info_transaction_with_http_info(transaction_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.commit_physical_info_transaction ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PhysicalInfoApi.commit_physical_info_transaction"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.commit_physical_info_transaction"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions/{transaction-id}'.sub('{' + 'transaction-id' + '}', CGI.escape(transaction_id.to_s)).sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#create_physical_info_transaction(user_id, opts = {}) ⇒ TransactionLocation

Create transaction Initiate physical info transaction. Check for new physical info and create a new transaction if found.

Parameters:

  • user_id (Integer) —

    User identifier

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 94

def create_physical_info_transaction(user_id, opts = {})
  data, _status_code, _headers = create_physical_info_transaction_with_http_info(user_id, opts)
  data
end

#create_physical_info_transaction_with_http_info(user_id, opts = {}) ⇒ Array<(TransactionLocation, Integer, Hash)>

Create transaction Initiate physical info transaction. Check for new physical info and create a new transaction if found.

Parameters:

  • user_id (Integer) —

    User identifier

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

    the optional parameters

Returns:

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

    TransactionLocation data, response status code and response headers



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
149
150
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 104

def create_physical_info_transaction_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.create_physical_info_transaction ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.create_physical_info_transaction"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions'.sub('{' + 'user-id' + '}', CGI.escape(user_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', 'application/xml'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionLocation'

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

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

#get_physical_info(user_id, transaction_id, physical_info_id, opts = {}) ⇒ PhysicalInformation

Get physical info Get physical info entity data

Parameters:

  • user_id (Integer) —

    User identifier

  • transaction_id (Integer) —

    Transaction identifier

  • physical_info_id (Integer) —

    Physical information identifier

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

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 159

def get_physical_info(user_id, transaction_id, physical_info_id, opts = {})
  data, _status_code, _headers = get_physical_info_with_http_info(user_id, transaction_id, physical_info_id, opts)
  data
end

#get_physical_info_with_http_info(user_id, transaction_id, physical_info_id, opts = {}) ⇒ Array<(PhysicalInformation, Integer, Hash)>

Get physical info Get physical info entity data

Parameters:

  • user_id (Integer) —

    User identifier

  • transaction_id (Integer) —

    Transaction identifier

  • physical_info_id (Integer) —

    Physical information identifier

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

    the optional parameters

Returns:

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

    PhysicalInformation data, response status code and response headers



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 171

def get_physical_info_with_http_info(user_id, transaction_id, physical_info_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.get_physical_info ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.get_physical_info"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PhysicalInfoApi.get_physical_info"
  end
  # verify the required parameter 'physical_info_id' is set
  if @api_client.config.client_side_validation && physical_info_id.nil?
    fail ArgumentError, "Missing the required parameter 'physical_info_id' when calling PhysicalInfoApi.get_physical_info"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id}'.sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'transaction-id' + '}', CGI.escape(transaction_id.to_s)).sub('{' + 'physical-info-id' + '}', CGI.escape(physical_info_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', 'application/xml'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PhysicalInformation'

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

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

#list_physical_infos(transaction_id, user_id, opts = {}) ⇒ PhysicalInformations

List physical infos List new physical info data. After successfully initiating a transaction, physical infos included within it can be retrieved with the provided transactionId.

Parameters:

  • transaction_id (Integer) —

    Transaction identifier

  • user_id (Integer) —

    User identifier

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 233

def list_physical_infos(transaction_id, user_id, opts = {})
  data, _status_code, _headers = list_physical_infos_with_http_info(transaction_id, user_id, opts)
  data
end

#list_physical_infos_with_http_info(transaction_id, user_id, opts = {}) ⇒ Array<(PhysicalInformations, Integer, Hash)>

List physical infos List new physical info data. After successfully initiating a transaction, physical infos included within it can be retrieved with the provided transactionId.

Parameters:

  • transaction_id (Integer) —

    Transaction identifier

  • user_id (Integer) —

    User identifier

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

    the optional parameters

Returns:

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

    PhysicalInformations data, response status code and response headers



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
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
 
# File 'lib/polar-accesslink-api-gem/api/physical_info_api.rb', line 244

def list_physical_infos_with_http_info(transaction_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhysicalInfoApi.list_physical_infos ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PhysicalInfoApi.list_physical_infos"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling PhysicalInfoApi.list_physical_infos"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}/physical-information-transactions/{transaction-id}'.sub('{' + 'transaction-id' + '}', CGI.escape(transaction_id.to_s)).sub('{' + 'user-id' + '}', CGI.escape(user_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', 'application/xml'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PhysicalInformations'

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

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