Class: OpenapiClient::PaymentSchedulesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentSchedulesApi

Returns a new instance of PaymentSchedulesApi.



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

def api_client
  @api_client
end

Instance Method Details

#cancel_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts = {}) ⇒ PaymentSchedulesResponse

Cancel a gateway payment schedule. Use this to cancel an existing gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

Returns:



34
35
36
37
 
# File 'lib/openapi_client/api/payment_schedules_api.rb', line 34

def cancel_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts = {})
  data, _status_code, _headers = cancel_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts)
  data
end

#cancel_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts = {}) ⇒ Array<(PaymentSchedulesResponse, Integer, Hash)>

Cancel a gateway payment schedule. Use this to cancel an existing gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

Returns:

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

    PaymentSchedulesResponse data, response status code and response headers



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

def cancel_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentSchedulesApi.cancel_payment_schedule ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentSchedulesApi.cancel_payment_schedule"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentSchedulesApi.cancel_payment_schedule"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentSchedulesApi.cancel_payment_schedule"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentSchedulesApi.cancel_payment_schedule"
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentSchedulesApi.cancel_payment_schedule"
  end
  # resource path
  local_var_path = '/payment-schedules/{order-id}'.sub('{' + 'order-id' + '}', CGI.escape(order_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

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

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

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

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

#create_payment_schedule(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts = {}) ⇒ PaymentSchedulesResponse

Create gateway payment schedule. Use this to create a gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • payment_schedules_request (PaymentSchedulesRequest) —

    Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

Returns:



137
138
139
140
 
# File 'lib/openapi_client/api/payment_schedules_api.rb', line 137

def create_payment_schedule(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts = {})
  data, _status_code, _headers = create_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts)
  data
end

#create_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts = {}) ⇒ Array<(PaymentSchedulesResponse, Integer, Hash)>

Create gateway payment schedule. Use this to create a gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • payment_schedules_request (PaymentSchedulesRequest) —

    Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

Returns:

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

    PaymentSchedulesResponse 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
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
 
# File 'lib/openapi_client/api/payment_schedules_api.rb', line 153

def create_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentSchedulesApi.create_payment_schedule ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentSchedulesApi.create_payment_schedule"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentSchedulesApi.create_payment_schedule"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentSchedulesApi.create_payment_schedule"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentSchedulesApi.create_payment_schedule"
  end
  # verify the required parameter 'payment_schedules_request' is set
  if @api_client.config.client_side_validation && payment_schedules_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_schedules_request' when calling PaymentSchedulesApi.create_payment_schedule"
  end
  # resource path
  local_var_path = '/payment-schedules'

  # 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'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payment_schedules_request) 

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

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

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

#inquiry_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts = {}) ⇒ RecurringPaymentDetailsResponse

View a gateway payment schedule. Use this to view an existing gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

Returns:



241
242
243
244
 
# File 'lib/openapi_client/api/payment_schedules_api.rb', line 241

def inquiry_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts = {})
  data, _status_code, _headers = inquiry_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts)
  data
end

#inquiry_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts = {}) ⇒ Array<(RecurringPaymentDetailsResponse, Integer, Hash)>

View a gateway payment schedule. Use this to view an existing gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

Returns:



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

def inquiry_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentSchedulesApi.inquiry_payment_schedule ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentSchedulesApi.inquiry_payment_schedule"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentSchedulesApi.inquiry_payment_schedule"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentSchedulesApi.inquiry_payment_schedule"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentSchedulesApi.inquiry_payment_schedule"
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentSchedulesApi.inquiry_payment_schedule"
  end
  # resource path
  local_var_path = '/payment-schedules/{order-id}'.sub('{' + 'order-id' + '}', CGI.escape(order_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

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

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

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

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

#update_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts = {}) ⇒ PaymentSchedulesResponse

Update a gateway payment schedule. Use this to update a gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

  • payment_schedules_request (PaymentSchedulesRequest) —

    Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

Returns:



345
346
347
348
 
# File 'lib/openapi_client/api/payment_schedules_api.rb', line 345

def update_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts = {})
  data, _status_code, _headers = update_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts)
  data
end

#update_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts = {}) ⇒ Array<(PaymentSchedulesResponse, Integer, Hash)>

Update a gateway payment schedule. Use this to update a gateway payment schedule.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

  • payment_schedules_request (PaymentSchedulesRequest) —

    Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

Returns:

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

    PaymentSchedulesResponse data, response status code and response headers



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/openapi_client/api/payment_schedules_api.rb', line 362

def update_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentSchedulesApi.update_payment_schedule ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentSchedulesApi.update_payment_schedule"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentSchedulesApi.update_payment_schedule"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentSchedulesApi.update_payment_schedule"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentSchedulesApi.update_payment_schedule"
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling PaymentSchedulesApi.update_payment_schedule"
  end
  # verify the required parameter 'payment_schedules_request' is set
  if @api_client.config.client_side_validation && payment_schedules_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_schedules_request' when calling PaymentSchedulesApi.update_payment_schedule"
  end
  # resource path
  local_var_path = '/payment-schedules/{order-id}'.sub('{' + 'order-id' + '}', CGI.escape(order_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'])
  # HTTP header 'Content-Type'
  # header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payment_schedules_request) 

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

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

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