Class: KoronaClient::DeliveryNotesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/delivery_notes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeliveryNotesApi

Returns a new instance of DeliveryNotesApi.



19
20
21
 
# File 'lib/korona_client/api/delivery_notes_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/korona_client/api/delivery_notes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_delivery_notes(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds delivery notes

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    data to add

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 28

def add_delivery_notes(, body, opts = {})
  data, _status_code, _headers = add_delivery_notes_with_http_info(, body, opts)
  data
end

#add_delivery_notes_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds delivery notes

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    data to add

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 39

def add_delivery_notes_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryNotesApi.add_delivery_notes ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DeliveryNotesApi.add_delivery_notes"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DeliveryNotesApi.add_delivery_notes"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/deliveryNotes'.sub('{' + 'koronaAccountId' + '}', .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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#book_delivery_note(korona_account_id, delivery_note_id, opts = {}) ⇒ nil

book the single delivery note

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • delivery_note_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 88

def book_delivery_note(, delivery_note_id, opts = {})
  book_delivery_note_with_http_info(, delivery_note_id, opts)
  nil
end

#book_delivery_note_with_http_info(korona_account_id, delivery_note_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

book the single delivery note

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • delivery_note_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 99

def book_delivery_note_with_http_info(, delivery_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryNotesApi.book_delivery_note ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DeliveryNotesApi.book_delivery_note"
  end
  # verify the required parameter 'delivery_note_id' is set
  if @api_client.config.client_side_validation && delivery_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_note_id' when calling DeliveryNotesApi.book_delivery_note"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/deliveryNotes/{deliveryNoteId}/book'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'deliveryNoteId' + '}', delivery_note_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, 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: DeliveryNotesApi#book_delivery_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finalize_delivery_note(korona_account_id, delivery_note_id, opts = {}) ⇒ nil

finalize the single delivery note

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • delivery_note_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (nil) 


147
148
149
150
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 147

def finalize_delivery_note(, delivery_note_id, opts = {})
  finalize_delivery_note_with_http_info(, delivery_note_id, opts)
  nil
end

#finalize_delivery_note_with_http_info(korona_account_id, delivery_note_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

finalize the single delivery note

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • delivery_note_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



158
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
192
193
194
195
196
197
198
199
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 158

def finalize_delivery_note_with_http_info(, delivery_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryNotesApi.finalize_delivery_note ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DeliveryNotesApi.finalize_delivery_note"
  end
  # verify the required parameter 'delivery_note_id' is set
  if @api_client.config.client_side_validation && delivery_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_note_id' when calling DeliveryNotesApi.finalize_delivery_note"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/deliveryNotes/{deliveryNoteId}/finalize'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'deliveryNoteId' + '}', delivery_note_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, 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: DeliveryNotesApi#finalize_delivery_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_delivery_note(korona_account_id, delivery_note_id, opts = {}) ⇒ DeliveryNote

returns a single delivery note

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • delivery_note_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



206
207
208
209
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 206

def get_delivery_note(, delivery_note_id, opts = {})
  data, _status_code, _headers = get_delivery_note_with_http_info(, delivery_note_id, opts)
  data
end

#get_delivery_note_with_http_info(korona_account_id, delivery_note_id, opts = {}) ⇒ Array<(DeliveryNote, Fixnum, Hash)>

returns a single delivery note

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • delivery_note_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    DeliveryNote data, response status code and response headers



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
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 217

def get_delivery_note_with_http_info(, delivery_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryNotesApi.get_delivery_note ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DeliveryNotesApi.get_delivery_note"
  end
  # verify the required parameter 'delivery_note_id' is set
  if @api_client.config.client_side_validation && delivery_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_note_id' when calling DeliveryNotesApi.get_delivery_note"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/deliveryNotes/{deliveryNoteId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'deliveryNoteId' + '}', delivery_note_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_delivery_notes(korona_account_id, opts = {}) ⇒ ResultListDeliveryNote

lists all delivery notes

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :min_delivery_time (DateTime) —

    min (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone)

  • :max_delivery_time (DateTime) —

    max (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone)

  • :min_booking_time (DateTime) —

    min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :max_booking_time (DateTime) —

    max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :point_of_sale (String) —

    point of sale

  • :organizational_unit (String) —

    organizational unit

  • :customer (String) —

    customer id to filter by

  • :number (String) —

    number of the related object

Returns:



278
279
280
281
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 278

def get_delivery_notes(, opts = {})
  data, _status_code, _headers = get_delivery_notes_with_http_info(, opts)
  data
end

#get_delivery_notes_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListDeliveryNote, Fixnum, Hash)>

lists all delivery notes

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :min_delivery_time (DateTime) —

    min (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone)

  • :max_delivery_time (DateTime) —

    max (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone)

  • :min_booking_time (DateTime) —

    min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :max_booking_time (DateTime) —

    max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :point_of_sale (String) —

    point of sale

  • :organizational_unit (String) —

    organizational unit

  • :customer (String) —

    customer id to filter by

  • :number (String) —

    number of the related object

Returns:

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

    ResultListDeliveryNote data, response status code and response headers



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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/korona_client/api/delivery_notes_api.rb', line 301

def get_delivery_notes_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryNotesApi.get_delivery_notes ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DeliveryNotesApi.get_delivery_notes"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/deliveryNotes'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'minDeliveryTime'] = opts[:'min_delivery_time'] if !opts[:'min_delivery_time'].nil?
  query_params[:'maxDeliveryTime'] = opts[:'max_delivery_time'] if !opts[:'max_delivery_time'].nil?
  query_params[:'minBookingTime'] = opts[:'min_booking_time'] if !opts[:'min_booking_time'].nil?
  query_params[:'maxBookingTime'] = opts[:'max_booking_time'] if !opts[:'max_booking_time'].nil?
  query_params[:'pointOfSale'] = opts[:'point_of_sale'] if !opts[:'point_of_sale'].nil?
  query_params[:'organizationalUnit'] = opts[:'organizational_unit'] if !opts[:'organizational_unit'].nil?
  query_params[:'customer'] = opts[:'customer'] if !opts[:'customer'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?

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

  # form parameters
  form_params = {}

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