Class: TripletexApi::ProductApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/product_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductApi

Returns a new instance of ProductApi.



19
20
21
 
# File 'lib/tripletex_api/api/product_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_api/api/product_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Get product by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/product_api.rb', line 29

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

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

Get product by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperProduct data, response status code and response headers



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
 
# File 'lib/tripletex_api/api/product_api.rb', line 40

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

#post(opts = {}) ⇒ ResponseWrapperProduct

Create new product.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Product) —

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

Returns:



82
83
84
85
 
# File 'lib/tripletex_api/api/product_api.rb', line 82

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

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

Create new product.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Product) —

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

Returns:

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

    ResponseWrapperProduct data, response status code and response headers



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
124
 
# File 'lib/tripletex_api/api/product_api.rb', line 92

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductApi.post ..."
  end
  # resource path
  local_var_path = "/product"

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

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

Update product.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Product) —

    Partial object describing what should be updated

Returns:



132
133
134
135
 
# File 'lib/tripletex_api/api/product_api.rb', line 132

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

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

Update product.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Product) —

    Partial object describing what should be updated

Returns:

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

    ResponseWrapperProduct data, response status code and response headers



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
 
# File 'lib/tripletex_api/api/product_api.rb', line 143

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

#search(opts = {}) ⇒ ListResponseProduct

Find products corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    DEPRECATED. List of product numbers (Integer only)

  • :product_number (Array<String>) —

    List of valid product numbers

  • :name (String) —

    Containing

  • :is_inactive (BOOLEAN) —

    Equals

  • :is_stock_item (BOOLEAN) —

    Equals

  • :currency_id (String) —

    Equals

  • :vat_type_id (String) —

    Equals

  • :product_unit_id (String) —

    Equals

  • :department_id (String) —

    Equals

  • :account_id (String) —

    Equals

  • :cost_excluding_vat_currency_from (Float) —

    From and including

  • :cost_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_excluding_vat_currency_from (Float) —

    From and including

  • :price_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_including_vat_currency_from (Float) —

    From and including

  • :price_including_vat_currency_to (Float) —

    To and excluding

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



205
206
207
208
 
# File 'lib/tripletex_api/api/product_api.rb', line 205

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

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

Find products corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    DEPRECATED. List of product numbers (Integer only)

  • :product_number (Array<String>) —

    List of valid product numbers

  • :name (String) —

    Containing

  • :is_inactive (BOOLEAN) —

    Equals

  • :is_stock_item (BOOLEAN) —

    Equals

  • :currency_id (String) —

    Equals

  • :vat_type_id (String) —

    Equals

  • :product_unit_id (String) —

    Equals

  • :department_id (String) —

    Equals

  • :account_id (String) —

    Equals

  • :cost_excluding_vat_currency_from (Float) —

    From and including

  • :cost_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_excluding_vat_currency_from (Float) —

    From and including

  • :price_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_including_vat_currency_from (Float) —

    From and including

  • :price_including_vat_currency_to (Float) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseProduct data, response status code and response headers



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
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/tripletex_api/api/product_api.rb', line 234

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProductApi.search ..."
  end
  # resource path
  local_var_path = "/product"

  # query parameters
  query_params = {}
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'productNumber'] = @api_client.build_collection_param(opts[:'product_number'], :multi) if !opts[:'product_number'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'isInactive'] = opts[:'is_inactive'] if !opts[:'is_inactive'].nil?
  query_params[:'isStockItem'] = opts[:'is_stock_item'] if !opts[:'is_stock_item'].nil?
  query_params[:'currencyId'] = opts[:'currency_id'] if !opts[:'currency_id'].nil?
  query_params[:'vatTypeId'] = opts[:'vat_type_id'] if !opts[:'vat_type_id'].nil?
  query_params[:'productUnitId'] = opts[:'product_unit_id'] if !opts[:'product_unit_id'].nil?
  query_params[:'departmentId'] = opts[:'department_id'] if !opts[:'department_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'costExcludingVatCurrencyFrom'] = opts[:'cost_excluding_vat_currency_from'] if !opts[:'cost_excluding_vat_currency_from'].nil?
  query_params[:'costExcludingVatCurrencyTo'] = opts[:'cost_excluding_vat_currency_to'] if !opts[:'cost_excluding_vat_currency_to'].nil?
  query_params[:'priceExcludingVatCurrencyFrom'] = opts[:'price_excluding_vat_currency_from'] if !opts[:'price_excluding_vat_currency_from'].nil?
  query_params[:'priceExcludingVatCurrencyTo'] = opts[:'price_excluding_vat_currency_to'] if !opts[:'price_excluding_vat_currency_to'].nil?
  query_params[:'priceIncludingVatCurrencyFrom'] = opts[:'price_including_vat_currency_from'] if !opts[:'price_including_vat_currency_from'].nil?
  query_params[:'priceIncludingVatCurrencyTo'] = opts[:'price_including_vat_currency_to'] if !opts[:'price_including_vat_currency_to'].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 => 'ListResponseProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end