Skip to content

ProductexternalApi.md

Latest commit

 

History

History
157 lines (118 loc) · 5.04 KB

ProductexternalApi.md

File metadata and controls

157 lines (118 loc) · 5.04 KB

TripletexRubyClient::ProductexternalApi

All URIs are relative to https://tripletex.no/v2

Method HTTP request Description
get GET /product/external/{id} [BETA] Get external product by ID.
search GET /product/external [BETA] Find external products corresponding with sent data. The sorting-field is not in use on this endpoint.

get

ResponseWrapperExternalProduct get(id, opts)

[BETA] Get external product by ID.

Example

# load the gem
require 'tripletex_ruby_client'
# setup authorization
# # Setup authorization - as autogenerated by swagger-codegen
# TripletexRubyClient.configure do |config|
#   # Configure HTTP basic authorization: tokenAuthScheme
#   config.username = 'YOUR USERNAME'
#   config.password = 'YOUR PASSWORD'
# end
# Setup authorization
# 
TripletexRubyClient.configure do |config|
  # Configure HTTP basic authorization: tokenAuthScheme
  config.consumer_token = ENV["TT_CONSUMER_TOKEN"]
  config.employee_token = ENV["TT_EMPLOYEE_TOKEN"]
  config.host = Rails.env.production? ? 'https://tripletex.no' : 'https://api.tripletex.io'
  config.token_expiration_time = Rails.env.production? ? 1.month : 1.day
end
api_instance = TripletexRubyClient::ProductexternalApi.new

id = 56 # Integer | Element ID

opts = { 
  fields: 'fields_example' # String | Fields filter pattern
}

begin
  #[BETA] Get external product by ID.
  result = api_instance.get(id, opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling ProductexternalApi->get: #{e}"
end

Parameters

Name Type Description Notes
id Integer Element ID
fields String Fields filter pattern [optional]

Return type

ResponseWrapperExternalProduct

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

search

ListResponseExternalProduct search(opts)

[BETA] Find external products corresponding with sent data. The sorting-field is not in use on this endpoint.

Example

# load the gem
require 'tripletex_ruby_client'
# setup authorization
# # Setup authorization - as autogenerated by swagger-codegen
# TripletexRubyClient.configure do |config|
#   # Configure HTTP basic authorization: tokenAuthScheme
#   config.username = 'YOUR USERNAME'
#   config.password = 'YOUR PASSWORD'
# end
# Setup authorization
# 
TripletexRubyClient.configure do |config|
  # Configure HTTP basic authorization: tokenAuthScheme
  config.consumer_token = ENV["TT_CONSUMER_TOKEN"]
  config.employee_token = ENV["TT_EMPLOYEE_TOKEN"]
  config.host = Rails.env.production? ? 'https://tripletex.no' : 'https://api.tripletex.io'
  config.token_expiration_time = Rails.env.production? ? 1.month : 1.day
end
api_instance = TripletexRubyClient::ProductexternalApi.new

opts = { 
  name: 'name_example', # String | Containing
  wholesaler: 'wholesaler_example', # String | Wholesaler
  organization_number: 'organization_number_example', # String | Wholesaler organization number. Mandatory if Wholesaler is not selected. If Wholesaler is selected, this field is ignored.
  el_number: 'el_number_example', # String | List of valid el numbers
  nrf_number: 'nrf_number_example', # String | List of valid nrf numbers
  is_inactive: true, # BOOLEAN | Equals
  from: 0, # Integer | From index
  count: 1000, # Integer | Number of elements to return
  sorting: 'sorting_example', # String | Sorting pattern
  fields: 'fields_example' # String | Fields filter pattern
}

begin
  #[BETA] Find external products corresponding with sent data. The sorting-field is not in use on this endpoint.
  result = api_instance.search(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling ProductexternalApi->search: #{e}"
end

Parameters

Name Type Description Notes
name String Containing [optional]
wholesaler String Wholesaler [optional]
organization_number String Wholesaler organization number. Mandatory if Wholesaler is not selected. If Wholesaler is selected, this field is ignored. [optional]
el_number String List of valid el numbers [optional]
nrf_number String List of valid nrf numbers [optional]
is_inactive BOOLEAN Equals [optional]
from Integer From index [optional] [default to 0]
count Integer Number of elements to return [optional] [default to 1000]
sorting String Sorting pattern [optional]
fields String Fields filter pattern [optional]

Return type

ListResponseExternalProduct

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined