Class: TripletexRubyClient::PurchaseOrdergoodsReceiptLineApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PurchaseOrdergoodsReceiptLineApi

Returns a new instance of PurchaseOrdergoodsReceiptLineApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_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_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete(id, opts = {}) ⇒ nil

BETA

Delete goods receipt line by ID. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 27

def delete(id, opts = {})
  delete_with_http_info(id, opts)
  nil
end

#delete_list(opts = {}) ⇒ nil

BETA

Delete goods receipt lines by ID. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceiptLine>) —

    JSON representing objects to delete. Should have ID and version set.

Returns:

  • (nil) 


76
77
78
79
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 76

def delete_list(opts = {})
  delete_list_with_http_info(opts)
  nil
end

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

BETA

Delete goods receipt lines by ID. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceiptLine>) —

    JSON representing objects to delete. Should have ID and version set.

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 86

def delete_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.delete_list ...'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine/list'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Delete goods receipt line by ID. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Element 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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 37

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.delete ...'
  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 PurchaseOrdergoodsReceiptLineApi.delete"
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

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

BETA

Get goods receipt line by purchase order line ID. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



122
123
124
125
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 122

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

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

BETA

Get goods receipt line by purchase order line ID. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



133
134
135
136
137
138
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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 133

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.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 PurchaseOrdergoodsReceiptLineApi.get"
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine/{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 => 'ResponseWrapperGoodsReceiptLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptLineApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperGoodsReceiptLine

BETA

Register new goods receipt; new product on an existing purchase order. When registration of several goods receipt, use /list for better performance. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (GoodsReceiptLine) —

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

Returns:



174
175
176
177
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 174

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

#post_list(opts = {}) ⇒ ListResponseGoodsReceiptLine

BETA

Register multiple new goods receipt on an existing purchase order. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceiptLine>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:



222
223
224
225
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 222

def post_list(opts = {})
  data, _status_code, _headers = post_list_with_http_info(opts)
  data
end

#post_list_with_http_info(opts = {}) ⇒ Array<(ListResponseGoodsReceiptLine, Fixnum, Hash)>

BETA

Register multiple new goods receipt on an existing purchase order. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceiptLine>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:



232
233
234
235
236
237
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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 232

def post_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.post_list ...'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine/list'

  # 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 => 'ListResponseGoodsReceiptLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptLineApi#post_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

Register new goods receipt; new product on an existing purchase order. When registration of several goods receipt, use /list for better performance. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (GoodsReceiptLine) —

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

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 184

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.post ...'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine'

  # 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 => 'ResponseWrapperGoodsReceiptLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptLineApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

Update a goods receipt line on a goods receipt. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Goods receipt Line ID

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

    the optional parameters

Options Hash (opts):

Returns:



271
272
273
274
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 271

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

#put_list(opts = {}) ⇒ ListResponseGoodsReceiptLine

BETA

Update goods receipt lines on a goods receipt. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceiptLine>) —

    JSON representing updates to object. Should have ID and version set.

Returns:



324
325
326
327
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 324

def put_list(opts = {})
  data, _status_code, _headers = put_list_with_http_info(opts)
  data
end

#put_list_with_http_info(opts = {}) ⇒ Array<(ListResponseGoodsReceiptLine, Fixnum, Hash)>

BETA

Update goods receipt lines on a goods receipt. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceiptLine>) —

    JSON representing updates to object. Should have ID and version set.

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 334

def put_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.put_list ...'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine/list'

  # 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 => 'ListResponseGoodsReceiptLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptLineApi#put_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

Update a goods receipt line on a goods receipt. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Goods receipt Line ID

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 282

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptLineApi.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 PurchaseOrdergoodsReceiptLineApi.put"
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceiptLine/{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 => 'ResponseWrapperGoodsReceiptLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptLineApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(purchase_order_id, opts = {}) ⇒ ListResponseGoodsReceiptLine

BETA

Find goods receipt lines for purchase order. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • purchase_order_id —

    Equals

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

    the optional parameters

Options Hash (opts):

  • :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:



376
377
378
379
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 376

def search(purchase_order_id, opts = {})
  data, _status_code, _headers = search_with_http_info(purchase_order_id, opts)
  data
end

#search_with_http_info(purchase_order_id, opts = {}) ⇒ Array<(ListResponseGoodsReceiptLine, Fixnum, Hash)>

BETA

Find goods receipt lines for purchase order. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • purchase_order_id —

    Equals

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_line_api.rb', line 390

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

  # query parameters
  query_params = {}
  query_params[:'purchaseOrderId'] = purchase_order_id
  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 => 'ListResponseGoodsReceiptLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptLineApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end