Class: Patch::OrderLineItemsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/patch_ruby/api/order_line_items_api.rb

Constant Summary collapse

OPERATIONS = 
[
  :create_order_line_item,
  :delete_order_line_item,
  :update_order_line_item,
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrderLineItemsApi

Returns a new instance of OrderLineItemsApi.



25
26
27
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 25

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



23
24
25
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 23

def api_client
  @api_client
end

Instance Method Details

#create_order_line_item(order_id, create_order_line_item_request = {}, opts = {}) ⇒ OrderLineItemResponse

Creates an order line item Creates a line item on an order that is in the ‘draft` state.

Parameters:

  • order_id (String)
  • create_order_line_item_request (CreateOrderLineItemRequest) (defaults to: {})
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



35
36
37
38
39
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 35

def create_order_line_item(order_id, create_order_line_item_request = {}, opts = {})
  _create_order_line_item_request = Patch::CreateOrderLineItemRequest.new(create_order_line_item_request) 
  data, _status_code, _headers = create_order_line_item_with_http_info(order_id, _create_order_line_item_request, opts)
  data
end

#create_order_line_item_with_http_info(order_id, create_order_line_item_request, opts = {}) ⇒ Array<(OrderLineItemResponse, Integer, Hash)>

Creates an order line item Creates a line item on an order that is in the ‘draft` state.

Parameters:

  • order_id (String)
  • create_order_line_item_request (CreateOrderLineItemRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(OrderLineItemResponse, Integer, Hash)>) —

    OrderLineItemResponse data, response status code and response headers



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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 48

def create_order_line_item_with_http_info(order_id, create_order_line_item_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderLineItemsApi.create_order_line_item ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderLineItemsApi.create_order_line_item"
  end
  # verify the required parameter 'create_order_line_item_request' is set
  if @api_client.config.client_side_validation && create_order_line_item_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_order_line_item_request' when calling OrderLineItemsApi.create_order_line_item"
  end
  # resource path
  local_var_path = '/v1/orders/{order_id}/line_items'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_order_line_item_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OrderLineItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer_auth']

  new_options = opts.merge(
    :operation => :"OrderLineItemsApi.create_order_line_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderLineItemsApi#create_order_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_order_line_item(order_id, serial_number, opts = {}) ⇒ DeleteOrderLineItemResponse

Deletes an order line item Deletes a line item on an order that is in the ‘draft` state.

Parameters:

  • order_id (String)
  • serial_number (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



115
116
117
118
119
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 115

def delete_order_line_item(order_id, serial_number, opts = {})

  data, _status_code, _headers = delete_order_line_item_with_http_info(order_id, serial_number, opts)
  data
end

#delete_order_line_item_with_http_info(order_id, serial_number, opts = {}) ⇒ Array<(DeleteOrderLineItemResponse, Integer, Hash)>

Deletes an order line item Deletes a line item on an order that is in the ‘draft` state.

Parameters:

  • order_id (String)
  • serial_number (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(DeleteOrderLineItemResponse, Integer, Hash)>) —

    DeleteOrderLineItemResponse data, response status code and response headers



128
129
130
131
132
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
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 128

def delete_order_line_item_with_http_info(order_id, serial_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderLineItemsApi.delete_order_line_item ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderLineItemsApi.delete_order_line_item"
  end
  # verify the required parameter 'serial_number' is set
  if @api_client.config.client_side_validation && serial_number.nil?
    fail ArgumentError, "Missing the required parameter 'serial_number' when calling OrderLineItemsApi.delete_order_line_item"
  end
  # resource path
  local_var_path = '/v1/orders/{order_id}/line_items/{serial_number}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s)).sub('{' + 'serial_number' + '}', CGI.escape(serial_number.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteOrderLineItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer_auth']

  new_options = opts.merge(
    :operation => :"OrderLineItemsApi.delete_order_line_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderLineItemsApi#delete_order_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_order_line_item(order_id, serial_number, update_order_line_item_request = {}, opts = {}) ⇒ OrderLineItemResponse

Updates an order line item Updates a line item on an order that is in the ‘draft` state.

Parameters:

  • order_id (String)
  • serial_number (String)
  • update_order_line_item_request (UpdateOrderLineItemRequest) (defaults to: {})
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:



191
192
193
194
195
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 191

def update_order_line_item(order_id, serial_number, update_order_line_item_request = {}, opts = {})
  _update_order_line_item_request = Patch::UpdateOrderLineItemRequest.new(update_order_line_item_request) 
  data, _status_code, _headers = update_order_line_item_with_http_info(order_id, serial_number, _update_order_line_item_request, opts)
  data
end

#update_order_line_item_with_http_info(order_id, serial_number, update_order_line_item_request, opts = {}) ⇒ Array<(OrderLineItemResponse, Integer, Hash)>

Updates an order line item Updates a line item on an order that is in the ‘draft` state.

Parameters:

  • order_id (String)
  • serial_number (String)
  • update_order_line_item_request (UpdateOrderLineItemRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :patch_version (Integer)

Returns:

  • (Array<(OrderLineItemResponse, Integer, Hash)>) —

    OrderLineItemResponse data, response status code and response headers



205
206
207
208
209
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/patch_ruby/api/order_line_items_api.rb', line 205

def update_order_line_item_with_http_info(order_id, serial_number, update_order_line_item_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrderLineItemsApi.update_order_line_item ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderLineItemsApi.update_order_line_item"
  end
  # verify the required parameter 'serial_number' is set
  if @api_client.config.client_side_validation && serial_number.nil?
    fail ArgumentError, "Missing the required parameter 'serial_number' when calling OrderLineItemsApi.update_order_line_item"
  end
  # verify the required parameter 'update_order_line_item_request' is set
  if @api_client.config.client_side_validation && update_order_line_item_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_order_line_item_request' when calling OrderLineItemsApi.update_order_line_item"
  end
  # resource path
  local_var_path = '/v1/orders/{order_id}/line_items/{serial_number}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s)).sub('{' + 'serial_number' + '}', CGI.escape(serial_number.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params['Patch-Version'] = 2
  header_params[:'Patch-Version'] = opts[:'patch_version'] if !opts[:'patch_version'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_order_line_item_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OrderLineItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer_auth']

  new_options = opts.merge(
    :operation => :"OrderLineItemsApi.update_order_line_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrderLineItemsApi#update_order_line_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end