Class: TripletexRubyClient::OrderorderGroupApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrderorderGroupApi

Returns a new instance of OrderorderGroupApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Beta

Delete orderGroup by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Beta

Delete orderGroup by ID.

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/orderorder_group_api.rb', line 37

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderorderGroupApi.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 OrderorderGroupApi.delete"
  end
  # resource path
  local_var_path = '/order/orderGroup/{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: OrderorderGroupApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Beta

Get orderGroup by ID. A orderGroup is a way to group orderLines, and add comments and subtotals

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



77
78
79
80
 
# File 'lib/tripletex_ruby_client/api/orderorder_group_api.rb', line 77

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

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

Beta

Get orderGroup by ID. A orderGroup is a way to group orderLines, and add comments and subtotals

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperOrderGroup data, 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/tripletex_ruby_client/api/orderorder_group_api.rb', line 88

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

#post(opts = {}) ⇒ ResponseWrapperOrderGroup

Beta

Post orderGroup.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (OrderGroup) —

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

  • :order_line_ids (String) —

    List of IDs

Returns:



130
131
132
133
 
# File 'lib/tripletex_ruby_client/api/orderorder_group_api.rb', line 130

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

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

Beta

Post orderGroup.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (OrderGroup) —

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

  • :order_line_ids (String) —

    List of IDs

Returns:

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

    ResponseWrapperOrderGroup data, response status code and response headers



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/tripletex_ruby_client/api/orderorder_group_api.rb', line 141

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

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

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

#put(opts = {}) ⇒ ResponseWrapperOrderGroup

Beta

Put orderGroup.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (OrderGroup) —

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

  • :order_line_ids (String) —

    List of IDs

  • :remove_existing_order_lines (BOOLEAN) —

    Should existing orderLines be removed from this orderGroup (default to false)

Returns:



182
183
184
185
 
# File 'lib/tripletex_ruby_client/api/orderorder_group_api.rb', line 182

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

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

Beta

Put orderGroup.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (OrderGroup) —

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

  • :order_line_ids (String) —

    List of IDs

  • :remove_existing_order_lines (BOOLEAN) —

    Should existing orderLines be removed from this orderGroup

Returns:

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

    ResponseWrapperOrderGroup data, response status code and response headers



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
226
227
228
 
# File 'lib/tripletex_ruby_client/api/orderorder_group_api.rb', line 194

def put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderorderGroupApi.put ...'
  end
  # resource path
  local_var_path = '/order/orderGroup'

  # query parameters
  query_params = {}
  query_params[:'OrderLineIds'] = opts[:'order_line_ids'] if !opts[:'order_line_ids'].nil?
  query_params[:'removeExistingOrderLines'] = opts[:'remove_existing_order_lines'] if !opts[:'remove_existing_order_lines'].nil?

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

#search(opts = {}) ⇒ ListResponseOrderGroup

BETA

Find orderGroups corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    List of IDs

  • :order_ids (String) —

    List of IDs

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



239
240
241
242
 
# File 'lib/tripletex_ruby_client/api/orderorder_group_api.rb', line 239

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

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

BETA

Find orderGroups corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    List of IDs

  • :order_ids (String) —

    List of IDs

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseOrderGroup data, response status code and response headers



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
282
283
284
285
286
287
288
289
290
 
# File 'lib/tripletex_ruby_client/api/orderorder_group_api.rb', line 254

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderorderGroupApi.search ...'
  end
  # resource path
  local_var_path = '/order/orderGroup'

  # query parameters
  query_params = {}
  query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
  query_params[:'orderIds'] = opts[:'order_ids'] if !opts[:'order_ids'].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 => 'ListResponseOrderGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderorderGroupApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end