Class: WhiteLabelMachineName::InstallmentPaymentService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InstallmentPaymentService

Returns a new instance of InstallmentPaymentService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 24

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#count(space_id, filter, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

  • space_id
  • filter —

    The filter which restricts the installment payment which are used to calculate the count.

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

    the optional parameters

Returns:

  • (Integer) 


34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 34

def count(space_id, filter, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, filter, opts)
  return data
end

#count_with_http_info(space_id, filter, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

  • space_id
  • filter —

    The filter which restricts the installment payment which are used to calculate the count.

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

    the optional parameters

Returns:

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

    Integer data, response status code and response headers



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/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 45

def count_with_http_info(space_id, filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InstallmentPaymentService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InstallmentPaymentService.count" if space_id.nil?
  # verify the required parameter 'filter' is set
  fail ArgumentError, "Missing the required parameter 'filter' when calling InstallmentPaymentService.count" if filter.nil?
  # resource path
  local_var_path = "/installment-payment/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(filter)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstallmentPaymentService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_installment_payment(space_id, transaction_id, installment_plan_configuration, opts = {}) ⇒ InstallmentPayment

Create Installment Payment This operation creates based up on the given transaction an installment payment.

Parameters:

  • space_id
  • transaction_id —

    The transaction which should be converted into an installment payment.

  • installment_plan_configuration —

    The installment plan configuration ID which should be applied on the transaction.

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 97

def create_installment_payment(space_id, transaction_id, installment_plan_configuration, opts = {})
  data, _status_code, _headers = create_installment_payment_with_http_info(space_id, transaction_id, installment_plan_configuration, opts)
  return data
end

#create_installment_payment_with_http_info(space_id, transaction_id, installment_plan_configuration, opts = {}) ⇒ Array<(InstallmentPayment, Fixnum, Hash)>

Create Installment Payment This operation creates based up on the given transaction an installment payment.

Parameters:

  • space_id
  • transaction_id —

    The transaction which should be converted into an installment payment.

  • installment_plan_configuration —

    The installment plan configuration ID which should be applied on the transaction.

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

    the optional parameters

Returns:

  • (Array<(InstallmentPayment, Fixnum, Hash)>) —

    InstallmentPayment 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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 109

def create_installment_payment_with_http_info(space_id, transaction_id, installment_plan_configuration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InstallmentPaymentService.create_installment_payment ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InstallmentPaymentService.create_installment_payment" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling InstallmentPaymentService.create_installment_payment" if transaction_id.nil?
  # verify the required parameter 'installment_plan_configuration' is set
  fail ArgumentError, "Missing the required parameter 'installment_plan_configuration' when calling InstallmentPaymentService.create_installment_payment" if installment_plan_configuration.nil?
  # resource path
  local_var_path = "/installment-payment/createInstallmentPayment".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id
  query_params[:'installmentPlanConfiguration'] = installment_plan_configuration

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InstallmentPayment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstallmentPaymentService#create_installment_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(space_id, id, opts = {}) ⇒ InstallmentPayment

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the installment payment which should be returned.

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 164

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(InstallmentPayment, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • space_id
  • id —

    The id of the installment payment which should be returned.

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

    the optional parameters

Returns:

  • (Array<(InstallmentPayment, Fixnum, Hash)>) —

    InstallmentPayment data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 175

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InstallmentPaymentService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InstallmentPaymentService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling InstallmentPaymentService.read" if id.nil?
  # resource path
  local_var_path = "/installment-payment/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InstallmentPayment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstallmentPaymentService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(space_id, query, opts = {}) ⇒ Array<InstallmentPayment>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the installment payments which are returned by the search.

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

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 227

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<InstallmentPayment>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the installment payments which are returned by the search.

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

    the optional parameters

Returns:

  • (Array<(Array<InstallmentPayment>, Fixnum, Hash)>) —

    Array<InstallmentPayment> data, response status code and response headers



238
239
240
241
242
243
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_payment_service_api.rb', line 238

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InstallmentPaymentService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InstallmentPaymentService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling InstallmentPaymentService.search" if query.nil?
  # resource path
  local_var_path = "/installment-payment/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<InstallmentPayment>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstallmentPaymentService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end