Class: CybridApiBank::PaymentInstructionsBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentInstructionsBankApi

Returns a new instance of PaymentInstructionsBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_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/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment_instruction(post_payment_instruction_bank_model, opts = {}) ⇒ PaymentInstructionBankModel

Create Payment Instruction Creates a payment instruction. ## State | State | Description | |——-|————-| | storing | The Platform is storing the payment instruction details in our private store | | created | The Platform has created the payment instruction | | expired | The PaymentInstruction is no longer valid | Required scope: invoices:write

Parameters:

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 27

def create_payment_instruction(post_payment_instruction_bank_model, opts = {})
  data, _status_code, _headers = create_payment_instruction_with_http_info(post_payment_instruction_bank_model, opts)
  data
end

#create_payment_instruction_with_http_info(post_payment_instruction_bank_model, opts = {}) ⇒ Array<(PaymentInstructionBankModel, Integer, Hash)>

Create Payment Instruction Creates a payment instruction. ## State | State | Description | |——-|————-| | storing | The Platform is storing the payment instruction details in our private store | | created | The Platform has created the payment instruction | | expired | The PaymentInstruction is no longer valid | Required scope: invoices:write

Parameters:

Returns:

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

    PaymentInstructionBankModel 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
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 37

def create_payment_instruction_with_http_info(post_payment_instruction_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstructionsBankApi.create_payment_instruction ...'
  end
  # verify the required parameter 'post_payment_instruction_bank_model' is set
  if @api_client.config.client_side_validation && post_payment_instruction_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_payment_instruction_bank_model' when calling PaymentInstructionsBankApi.create_payment_instruction"
  end
  # resource path
  local_var_path = '/api/payment_instructions'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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

#get_payment_instruction(payment_instruction_guid, opts = {}) ⇒ PaymentInstructionBankModel

Get Payment Instruction Retrieves a payment_instruction. Required scope: invoices:read

Parameters:

  • payment_instruction_guid (String) —

    Identifier for the payment instruction.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 95

def get_payment_instruction(payment_instruction_guid, opts = {})
  data, _status_code, _headers = get_payment_instruction_with_http_info(payment_instruction_guid, opts)
  data
end

#get_payment_instruction_with_http_info(payment_instruction_guid, opts = {}) ⇒ Array<(PaymentInstructionBankModel, Integer, Hash)>

Get Payment Instruction Retrieves a payment_instruction. Required scope: invoices:read

Parameters:

  • payment_instruction_guid (String) —

    Identifier for the payment instruction.

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

    the optional parameters

Returns:

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

    PaymentInstructionBankModel data, response status code and response headers



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
151
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 105

def get_payment_instruction_with_http_info(payment_instruction_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstructionsBankApi.get_payment_instruction ...'
  end
  # verify the required parameter 'payment_instruction_guid' is set
  if @api_client.config.client_side_validation && payment_instruction_guid.nil?
    fail ArgumentError, "Missing the required parameter 'payment_instruction_guid' when calling PaymentInstructionsBankApi.get_payment_instruction"
  end
  # resource path
  local_var_path = '/api/payment_instructions/{payment_instruction_guid}'.sub('{' + 'payment_instruction_guid' + '}', CGI.escape(payment_instruction_guid.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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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

#list_payment_instructions(opts = {}) ⇒ PaymentInstructionListBankModel

List Payment Instructions Retrieves a list of payment instructions. Required scope: invoices:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated guids to list payment instructions for.

  • :bank_guid (String) —

    Comma separated bank_guids to list payment instructions for.

  • :customer_guid (String) —

    Comma separated customer_guids to list payment instructions for.

  • :invoice_guid (String) —

    Comma separated invoice_guids to list payment instructions for.

Returns:



163
164
165
166
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 163

def list_payment_instructions(opts = {})
  data, _status_code, _headers = list_payment_instructions_with_http_info(opts)
  data
end

#list_payment_instructions_with_http_info(opts = {}) ⇒ Array<(PaymentInstructionListBankModel, Integer, Hash)>

List Payment Instructions Retrieves a list of payment instructions. Required scope: invoices:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated guids to list payment instructions for.

  • :bank_guid (String) —

    Comma separated bank_guids to list payment instructions for.

  • :customer_guid (String) —

    Comma separated customer_guids to list payment instructions for.

  • :invoice_guid (String) —

    Comma separated invoice_guids to list payment instructions for.

Returns:



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
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb', line 178

def list_payment_instructions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstructionsBankApi.list_payment_instructions ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PaymentInstructionsBankApi.list_payment_instructions, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PaymentInstructionsBankApi.list_payment_instructions, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PaymentInstructionsBankApi.list_payment_instructions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/payment_instructions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
  query_params[:'invoice_guid'] = opts[:'invoice_guid'] if !opts[:'invoice_guid'].nil?

  # 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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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