Class: TripletexApi::OrderApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/order_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrderApi

Returns a new instance of OrderApi.



19
20
21
 
# File 'lib/tripletex_api/api/order_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/tripletex_api/api/order_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperOrder

Get order by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/order_api.rb', line 29

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  return data
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperOrder, Fixnum, Hash)>

Get order by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperOrder data, response status code and response headers



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
 
# File 'lib/tripletex_api/api/order_api.rb', line 40

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrderApi.get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OrderApi.get"
  end
  # resource path
  local_var_path = "/order/{id}".sub('{' + 'id' + '}', id.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#invoice(id, invoice_date, opts = {}) ⇒ ResponseWrapperInvoice

Create new invoice from order.

Parameters:

  • id —

    ID of order to invoice.

  • invoice_date —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :send_to_customer (BOOLEAN) —

    Send invoice to customer (default to true)

  • :payment_type_id (Integer) —

    Payment type to register prepayment of the invoice. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid.

  • :paid_amount (Float) —

    Paid amount to register prepayment of the invoice, in invoice currency. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid.

Returns:



86
87
88
89
 
# File 'lib/tripletex_api/api/order_api.rb', line 86

def invoice(id, invoice_date, opts = {})
  data, _status_code, _headers = invoice_with_http_info(id, invoice_date, opts)
  return data
end

#invoice_with_http_info(id, invoice_date, opts = {}) ⇒ Array<(ResponseWrapperInvoice, Fixnum, Hash)>

Create new invoice from order.

Parameters:

  • id —

    ID of order to invoice.

  • invoice_date —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :send_to_customer (BOOLEAN) —

    Send invoice to customer

  • :payment_type_id (Integer) —

    Payment type to register prepayment of the invoice. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid.

  • :paid_amount (Float) —

    Paid amount to register prepayment of the invoice, in invoice currency. paymentTypeId and paidAmount are optional, but both must be provided if the invoice has already been paid.

Returns:

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

    ResponseWrapperInvoice data, response status code and response headers



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/tripletex_api/api/order_api.rb', line 100

def invoice_with_http_info(id, invoice_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrderApi.invoice ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OrderApi.invoice"
  end
  # verify the required parameter 'invoice_date' is set
  if @api_client.config.client_side_validation && invoice_date.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_date' when calling OrderApi.invoice"
  end
  # resource path
  local_var_path = "/order/{id}/:invoice".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'invoiceDate'] = invoice_date
  query_params[:'sendToCustomer'] = opts[:'send_to_customer'] if !opts[:'send_to_customer'].nil?
  query_params[:'paymentTypeId'] = opts[:'payment_type_id'] if !opts[:'payment_type_id'].nil?
  query_params[:'paidAmount'] = opts[:'paid_amount'] if !opts[:'paid_amount'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#post(opts = {}) ⇒ ResponseWrapperOrder

Create order.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Order) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



149
150
151
152
 
# File 'lib/tripletex_api/api/order_api.rb', line 149

def post(opts = {})
  data, _status_code, _headers = post_with_http_info(opts)
  return data
end

#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperOrder, Fixnum, Hash)>

Create order.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Order) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:

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

    ResponseWrapperOrder data, response status code and response headers



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
 
# File 'lib/tripletex_api/api/order_api.rb', line 159

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrderApi.post ..."
  end
  # resource path
  local_var_path = "/order"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#put(id, opts = {}) ⇒ ResponseWrapperOrder

Update order.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Order) —

    Partial object describing what should be updated

Returns:



199
200
201
202
 
# File 'lib/tripletex_api/api/order_api.rb', line 199

def put(id, opts = {})
  data, _status_code, _headers = put_with_http_info(id, opts)
  return data
end

#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperOrder, Fixnum, Hash)>

Update order.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Order) —

    Partial object describing what should be updated

Returns:

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

    ResponseWrapperOrder data, response status code and response headers



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
239
240
241
242
243
244
245
246
 
# File 'lib/tripletex_api/api/order_api.rb', line 210

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrderApi.put ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OrderApi.put"
  end
  # resource path
  local_var_path = "/order/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#search(order_date_from, order_date_to, opts = {}) ⇒ ListResponseOrder

Find orders corresponding with sent data.

Parameters:

  • order_date_from —

    From and including

  • order_date_to —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :number (String) —

    Equals

  • :customer_id (String) —

    List of IDs

  • :is_closed (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



262
263
264
265
 
# File 'lib/tripletex_api/api/order_api.rb', line 262

def search(order_date_from, order_date_to, opts = {})
  data, _status_code, _headers = search_with_http_info(order_date_from, order_date_to, opts)
  return data
end

#search_with_http_info(order_date_from, order_date_to, opts = {}) ⇒ Array<(ListResponseOrder, Fixnum, Hash)>

Find orders corresponding with sent data.

Parameters:

  • order_date_from —

    From and including

  • order_date_to —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :number (String) —

    Equals

  • :customer_id (String) —

    List of IDs

  • :is_closed (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseOrder data, response status code and response headers



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
 
# File 'lib/tripletex_api/api/order_api.rb', line 281

def search_with_http_info(order_date_from, order_date_to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrderApi.search ..."
  end
  # verify the required parameter 'order_date_from' is set
  if @api_client.config.client_side_validation && order_date_from.nil?
    fail ArgumentError, "Missing the required parameter 'order_date_from' when calling OrderApi.search"
  end
  # verify the required parameter 'order_date_to' is set
  if @api_client.config.client_side_validation && order_date_to.nil?
    fail ArgumentError, "Missing the required parameter 'order_date_to' when calling OrderApi.search"
  end
  # resource path
  local_var_path = "/order"

  # query parameters
  query_params = {}
  query_params[:'orderDateFrom'] = order_date_from
  query_params[:'orderDateTo'] = order_date_to
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  query_params[:'isClosed'] = opts[:'is_closed'] if !opts[:'is_closed'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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