Class: TripletexRubyClient::InventoryinventoriesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InventoryinventoriesApi

Returns a new instance of InventoryinventoriesApi.



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

def api_client
  @api_client
end

Instance Method Details

#search(date_from, date_to, opts = {}) ⇒ ListResponseInventories

BETA

Find inventories corresponding with sent data.

Parameters:

  • date_from —

    Format is yyyy-MM-dd (from and incl.).

  • date_to —

    Format is yyyy-MM-dd (to and incl.).

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

    the optional parameters

Options Hash (opts):

  • :product_id (Integer) —

    Element ID

  • :inventory_id (Integer) —

    Element ID

  • :only_product_with_changed_status (BOOLEAN) — default: default to false
  • :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:



35
36
37
38
 
# File 'lib/tripletex_ruby_client/api/inventoryinventories_api.rb', line 35

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

#search_with_http_info(date_from, date_to, opts = {}) ⇒ Array<(ListResponseInventories, Fixnum, Hash)>

BETA

Find inventories corresponding with sent data.

Parameters:

  • date_from —

    Format is yyyy-MM-dd (from and incl.).

  • date_to —

    Format is yyyy-MM-dd (to and incl.).

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

    the optional parameters

Options Hash (opts):

  • :product_id (Integer) —

    Element ID

  • :inventory_id (Integer) —

    Element ID

  • :only_product_with_changed_status (BOOLEAN)
  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseInventories data, response status code and response headers



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
 
# File 'lib/tripletex_ruby_client/api/inventoryinventories_api.rb', line 53

def search_with_http_info(date_from, date_to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoryinventoriesApi.search ...'
  end
  # verify the required parameter 'date_from' is set
  if @api_client.config.client_side_validation && date_from.nil?
    fail ArgumentError, "Missing the required parameter 'date_from' when calling InventoryinventoriesApi.search"
  end
  # verify the required parameter 'date_to' is set
  if @api_client.config.client_side_validation && date_to.nil?
    fail ArgumentError, "Missing the required parameter 'date_to' when calling InventoryinventoriesApi.search"
  end
  # resource path
  local_var_path = '/inventory/inventories'

  # query parameters
  query_params = {}
  query_params[:'dateFrom'] = date_from
  query_params[:'dateTo'] = date_to
  query_params[:'productId'] = opts[:'product_id'] if !opts[:'product_id'].nil?
  query_params[:'inventoryId'] = opts[:'inventory_id'] if !opts[:'inventory_id'].nil?
  query_params[:'onlyProductWithChangedStatus'] = opts[:'only_product_with_changed_status'] if !opts[:'only_product_with_changed_status'].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 => 'ListResponseInventories')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoryinventoriesApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end