Class: TripletexRubyClient::ProductunitmasterApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductunitmasterApi 



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

def api_client
  @api_client
end

Instance Method Details

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

BETA

Get product unit master by ID.

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern



28
29
30
31
 
# File 'lib/tripletex_ruby_client/api/productunitmaster_api.rb', line 28

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

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

BETA

Get product unit master by ID.

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern



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
71
72
73
74
 
# File 'lib/tripletex_ruby_client/api/productunitmaster_api.rb', line 39

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

#search(opts = {}) ⇒ ListResponseProductUnitMaster

BETA

Find product units master corresponding with sent data.

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :name (String) —

    Names

  • :name_short (String) —

    Short names

  • :common_code (String) —

    Common codes

  • :peppol_name (String) —

    Peppol names

  • :peppol_symbol (String) —

    Peppol symbols

  • :is_inactive (BOOLEAN) —

    Inactive units

  • :count (Integer) —

    Number of elements to return (default to 2100)

  • :from (Integer) —

    From index (default to 0)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern



90
91
92
93
 
# File 'lib/tripletex_ruby_client/api/productunitmaster_api.rb', line 90

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

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

BETA

Find product units master corresponding with sent data.

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :name (String) —

    Names

  • :name_short (String) —

    Short names

  • :common_code (String) —

    Common codes

  • :peppol_name (String) —

    Peppol names

  • :peppol_symbol (String) —

    Peppol symbols

  • :is_inactive (BOOLEAN) —

    Inactive units

  • :count (Integer) —

    Number of elements to return

  • :from (Integer) —

    From index

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern



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
146
147
148
149
150
151
 
# File 'lib/tripletex_ruby_client/api/productunitmaster_api.rb', line 110

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

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'nameShort'] = opts[:'name_short'] if !opts[:'name_short'].nil?
  query_params[:'commonCode'] = opts[:'common_code'] if !opts[:'common_code'].nil?
  query_params[:'peppolName'] = opts[:'peppol_name'] if !opts[:'peppol_name'].nil?
  query_params[:'peppolSymbol'] = opts[:'peppol_symbol'] if !opts[:'peppol_symbol'].nil?
  query_params[:'isInactive'] = opts[:'is_inactive'] if !opts[:'is_inactive'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].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 => 'ListResponseProductUnitMaster')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductunitmasterApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end