TripletexRubyClient::EventsubscriptionApi

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

Method	HTTP request	Description
delete	DELETE /event/subscription/{id}	[BETA] Delete the given subscription.
delete_by_ids	DELETE /event/subscription/list	[BETA] Delete multiple subscriptions.
get	GET /event/subscription/{id}	[BETA] Get subscription by ID.
post	POST /event/subscription	[BETA] Create a new subscription for current EmployeeToken.
post_list	POST /event/subscription/list	[BETA] Create multiple subscriptions for current EmployeeToken.
put	PUT /event/subscription/{id}	[BETA] Change a current subscription, based on id.
put_list	PUT /event/subscription/list	[BETA] Update multiple subscription.
search	GET /event/subscription	[BETA] Find all ongoing subscriptions.

delete

delete(id)

[BETA] Delete the given subscription.

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::EventsubscriptionApi.new

id = 56 # Integer | Element ID


begin
  #[BETA] Delete the given subscription.
  api_instance.delete(id)
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID

Return type

nil (empty response body)

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

delete_by_ids

delete_by_ids(ids)

[BETA] Delete multiple subscriptions.

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::EventsubscriptionApi.new

ids = 'ids_example' # String | ID of the elements


begin
  #[BETA] Delete multiple subscriptions.
  api_instance.delete_by_ids(ids)
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->delete_by_ids: #{e}"
end

Parameters

Name	Type	Description	Notes
ids	String	ID of the elements

Return type

nil (empty response body)

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

get

ResponseWrapperSubscription get(id, opts)

[BETA] Get subscription 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::EventsubscriptionApi.new

id = 56 # Integer | Element ID

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

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

Parameters

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

Return type

ResponseWrapperSubscription

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

post

ResponseWrapperSubscription post(opts)

[BETA] Create a new subscription for current EmployeeToken.

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::EventsubscriptionApi.new

opts = { 
  body: TripletexRubyClient::Subscription.new # Subscription | JSON representing the new object to be created. Should not have ID and version set.
}

begin
  #[BETA] Create a new subscription for current EmployeeToken.
  result = api_instance.post(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Subscription	JSON representing the new object to be created. Should not have ID and version set.	[optional]

Return type

ResponseWrapperSubscription

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

post_list

ListResponseSubscription post_list(opts)

[BETA] Create multiple subscriptions for current EmployeeToken.

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::EventsubscriptionApi.new

opts = { 
  body: [TripletexRubyClient::Subscription.new] # Array<Subscription> | JSON representing a list of new object to be created. Should not have ID and version set.
}

begin
  #[BETA] Create multiple subscriptions for current EmployeeToken.
  result = api_instance.post_list(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->post_list: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Array<Subscription>	JSON representing a list of new object to be created. Should not have ID and version set.	[optional]

Return type

ListResponseSubscription

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

put

ResponseWrapperSubscription put(id, opts)

[BETA] Change a current subscription, based on 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::EventsubscriptionApi.new

id = 56 # Integer | Element ID

opts = { 
  body: TripletexRubyClient::Subscription.new # Subscription | Partial object describing what should be updated
}

begin
  #[BETA] Change a current subscription, based on id.
  result = api_instance.put(id, opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->put: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Element ID
body	Subscription	Partial object describing what should be updated	[optional]

Return type

ResponseWrapperSubscription

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

put_list

ListResponseSubscription put_list(opts)

[BETA] Update multiple subscription.

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::EventsubscriptionApi.new

opts = { 
  body: [TripletexRubyClient::Subscription.new] # Array<Subscription> | JSON representing updates to object. Should have ID and version set.
}

begin
  #[BETA] Update multiple subscription.
  result = api_instance.put_list(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->put_list: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Array<Subscription>	JSON representing updates to object. Should have ID and version set.	[optional]

Return type

ListResponseSubscription

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

search

ListResponseSubscription search(opts)

[BETA] Find all ongoing subscriptions.

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::EventsubscriptionApi.new

opts = { 
  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 all ongoing subscriptions.
  result = api_instance.search(opts)
  p result
rescue TripletexRubyClient::ApiError => e
  puts "Exception when calling EventsubscriptionApi->search: #{e}"
end

Parameters

Name	Type	Description	Notes
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

ListResponseSubscription

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

Files

EventsubscriptionApi.md

Latest commit

History

EventsubscriptionApi.md

File metadata and controls

TripletexRubyClient::EventsubscriptionApi

delete

Example

Parameters

Return type

Authorization

HTTP request headers

delete_by_ids

Example

Parameters

Return type

Authorization

HTTP request headers

get

Example

Parameters

Return type

Authorization

HTTP request headers

post

Example

Parameters

Return type

Authorization

HTTP request headers

post_list

Example

Parameters

Return type

Authorization

HTTP request headers

put

Example

Parameters

Return type

Authorization

HTTP request headers

put_list

Example

Parameters

Return type

Authorization

HTTP request headers

search

Example

Parameters

Return type

Authorization

HTTP request headers