Class: SubskribeSandboxClient::ERPApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/erp_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ERPApi

Returns a new instance of ERPApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/erp_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/subskribe_sandbox/api/erp_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#process_delete_tasks(accounting_period_id, opts = {}) ⇒ nil

Trigger ERP journal entry deletion task Trigger ERP journal entry deletion task for the given accounting period id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 27

def process_delete_tasks(accounting_period_id, opts = {})
  process_delete_tasks_with_http_info(accounting_period_id, opts)
  nil
end

#process_delete_tasks_with_http_info(accounting_period_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Trigger ERP journal entry deletion task Trigger ERP journal entry deletion task for the given accounting period id

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 37

def process_delete_tasks_with_http_info(accounting_period_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ERPApi.process_delete_tasks ...'
  end
  # verify the required parameter 'accounting_period_id' is set
  if @api_client.config.client_side_validation && accounting_period_id.nil?
    fail ArgumentError, "Missing the required parameter 'accounting_period_id' when calling ERPApi.process_delete_tasks"
  end
  # resource path
  local_var_path = '/erp/processDeleteTasks/{accountingPeriodId}'.sub('{' + 'accountingPeriodId' + '}', accounting_period_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ERPApi#process_delete_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#process_sync_tasks(accounting_period_id, opts = {}) ⇒ nil

Trigger ERP journal entry sync task Trigger ERP journal entry sync task for given accounting period id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


78
79
80
81
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 78

def process_sync_tasks(accounting_period_id, opts = {})
  process_sync_tasks_with_http_info(accounting_period_id, opts)
  nil
end

#process_sync_tasks_with_http_info(accounting_period_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Trigger ERP journal entry sync task Trigger ERP journal entry sync task for given accounting period id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 88

def process_sync_tasks_with_http_info(accounting_period_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ERPApi.process_sync_tasks ...'
  end
  # verify the required parameter 'accounting_period_id' is set
  if @api_client.config.client_side_validation && accounting_period_id.nil?
    fail ArgumentError, "Missing the required parameter 'accounting_period_id' when calling ERPApi.process_sync_tasks"
  end
  # resource path
  local_var_path = '/erp/processSyncTasks/{accountingPeriodId}'.sub('{' + 'accountingPeriodId' + '}', accounting_period_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ERPApi#process_sync_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_credit_memo_to_erp(credit_memo_number, opts = {}) ⇒ nil

Trigger ERP credit memo sync task Trigger ERP credit memo sync task for the given credit memo number

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


129
130
131
132
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 129

def sync_credit_memo_to_erp(credit_memo_number, opts = {})
  sync_credit_memo_to_erp_with_http_info(credit_memo_number, opts)
  nil
end

#sync_credit_memo_to_erp_with_http_info(credit_memo_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Trigger ERP credit memo sync task Trigger ERP credit memo sync task for the given credit memo number

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 139

def sync_credit_memo_to_erp_with_http_info(credit_memo_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ERPApi.sync_credit_memo_to_erp ...'
  end
  # verify the required parameter 'credit_memo_number' is set
  if @api_client.config.client_side_validation && credit_memo_number.nil?
    fail ArgumentError, "Missing the required parameter 'credit_memo_number' when calling ERPApi.sync_credit_memo_to_erp"
  end
  # resource path
  local_var_path = '/erp/syncCreditMemo/{creditMemoNumber}'.sub('{' + 'creditMemoNumber' + '}', credit_memo_number.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ERPApi#sync_credit_memo_to_erp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_invoice_to_erp(invoice_id, opts = {}) ⇒ nil

Trigger ERP invoice sync task Trigger ERP invoice sync task for the given invoice id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


180
181
182
183
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 180

def sync_invoice_to_erp(invoice_id, opts = {})
  sync_invoice_to_erp_with_http_info(invoice_id, opts)
  nil
end

#sync_invoice_to_erp_with_http_info(invoice_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Trigger ERP invoice sync task Trigger ERP invoice sync task for the given invoice id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/subskribe_sandbox/api/erp_api.rb', line 190

def sync_invoice_to_erp_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ERPApi.sync_invoice_to_erp ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling ERPApi.sync_invoice_to_erp"
  end
  # resource path
  local_var_path = '/erp/syncInvoice/{invoiceId}'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ERPApi#sync_invoice_to_erp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_void_invoice_to_erp(invoice_number, opts = {}) ⇒ nil

Trigger ERP void invoice sync task Trigger ERP void invoice sync task for the given invoice number

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


231
232
233
234
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 231

def sync_void_invoice_to_erp(invoice_number, opts = {})
  sync_void_invoice_to_erp_with_http_info(invoice_number, opts)
  nil
end

#sync_void_invoice_to_erp_with_http_info(invoice_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Trigger ERP void invoice sync task Trigger ERP void invoice sync task for the given invoice number

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/erp_api.rb', line 241

def sync_void_invoice_to_erp_with_http_info(invoice_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ERPApi.sync_void_invoice_to_erp ...'
  end
  # verify the required parameter 'invoice_number' is set
  if @api_client.config.client_side_validation && invoice_number.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_number' when calling ERPApi.sync_void_invoice_to_erp"
  end
  # resource path
  local_var_path = '/erp/syncVoidInvoice/{invoiceNumber}'.sub('{' + 'invoiceNumber' + '}', invoice_number.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ERPApi#sync_void_invoice_to_erp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end