Class: OrderCloud::BuyerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/buyer_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BuyerApi

Returns a new instance of BuyerApi.



30
31
32
 
# File 'lib/order_cloud/api/buyer_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/buyer_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(company, opts = {}) ⇒ Buyer

Parameters:

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/order_cloud/api/buyer_api.rb', line 39

def create(company, opts = {})
  data, _status_code, _headers = create_with_http_info(company, opts)
  return data
end

#create_with_http_info(company, opts = {}) ⇒ Array<(Buyer, Fixnum, Hash)>

Returns Buyer data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    Buyer data, response status code and response headers



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
 
# File 'lib/order_cloud/api/buyer_api.rb', line 49

def create_with_http_info(company, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BuyerApi.create ..."
  end
  # verify the required parameter 'company' is set
  fail ArgumentError, "Missing the required parameter 'company' when calling BuyerApi.create" if company.nil?
  # resource path
  local_var_path = "/buyers".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

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

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/order_cloud/api/buyer_api.rb', line 96

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

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
143
144
145
 
# File 'lib/order_cloud/api/buyer_api.rb', line 106

def delete_with_http_info(buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BuyerApi.delete ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling BuyerApi.delete" if buyer_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: BuyerApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(buyer_id, opts = {}) ⇒ Buyer

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/order_cloud/api/buyer_api.rb', line 152

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

#get_with_http_info(buyer_id, opts = {}) ⇒ Array<(Buyer, Fixnum, Hash)>

Returns Buyer data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    Buyer data, response status code and response headers



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
200
201
202
 
# File 'lib/order_cloud/api/buyer_api.rb', line 162

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#list(opts = {}) ⇒ ListBuyer

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the buyer.

  • :search_on (Array<String>) —

    Search on of the buyer.

  • :sort_by (Array<String>) —

    Sort by of the buyer.

  • :page (Integer) —

    Page of the buyer.

  • :page_size (Integer) —

    Page size of the buyer.

  • :filters (Hash<String, String>) —

    Filters of the buyer.

Returns:



214
215
216
217
 
# File 'lib/order_cloud/api/buyer_api.rb', line 214

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  return data
end

#list_with_http_info(opts = {}) ⇒ Array<(ListBuyer, Fixnum, Hash)>

Returns ListBuyer data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the buyer.

  • :search_on (Array<String>) —

    Search on of the buyer.

  • :sort_by (Array<String>) —

    Sort by of the buyer.

  • :page (Integer) —

    Page of the buyer.

  • :page_size (Integer) —

    Page size of the buyer.

  • :filters (Hash<String, String>) —

    Filters of the buyer.

Returns:

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

    ListBuyer data, response status code and response headers



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
268
269
270
271
272
273
 
# File 'lib/order_cloud/api/buyer_api.rb', line 229

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BuyerApi.list ..."
  end
  # resource path
  local_var_path = "/buyers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#patch(buyer_id, company, opts = {}) ⇒ Buyer

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/order_cloud/api/buyer_api.rb', line 281

def patch(buyer_id, company, opts = {})
  data, _status_code, _headers = patch_with_http_info(buyer_id, company, opts)
  return data
end

#patch_with_http_info(buyer_id, company, opts = {}) ⇒ Array<(Buyer, Fixnum, Hash)>

Returns Buyer data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    Buyer data, response status code and response headers



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
330
331
332
333
334
 
# File 'lib/order_cloud/api/buyer_api.rb', line 292

def patch_with_http_info(buyer_id, company, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BuyerApi.patch ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling BuyerApi.patch" if buyer_id.nil?
  # verify the required parameter 'company' is set
  fail ArgumentError, "Missing the required parameter 'company' when calling BuyerApi.patch" if company.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#update(buyer_id, company, opts = {}) ⇒ Buyer

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:



342
343
344
345
 
# File 'lib/order_cloud/api/buyer_api.rb', line 342

def update(buyer_id, company, opts = {})
  data, _status_code, _headers = update_with_http_info(buyer_id, company, opts)
  return data
end

#update_with_http_info(buyer_id, company, opts = {}) ⇒ Array<(Buyer, Fixnum, Hash)>

Returns Buyer data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    Buyer data, response status code and response headers



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/order_cloud/api/buyer_api.rb', line 353

def update_with_http_info(buyer_id, company, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BuyerApi.update ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling BuyerApi.update" if buyer_id.nil?
  # verify the required parameter 'company' is set
  fail ArgumentError, "Missing the required parameter 'company' when calling BuyerApi.update" if company.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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