tripletex_api 1.0.0

data/docs/EmployeeemploymentleaveOfAbsenceTypeApi.md

@@ -0,0 +1,69 @@
+# TripletexApi::EmployeeemploymentleaveOfAbsenceTypeApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](EmployeeemploymentleaveOfAbsenceTypeApi.md#search) | **GET** /employee/employment/leaveOfAbsenceType | [BETA] Find all leave of absence type IDs.
+
+
+# **search**
+> ListResponseLeaveOfAbsenceType search(opts)
+
+[BETA] Find all leave of absence type IDs.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeemploymentleaveOfAbsenceTypeApi.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 leave of absence type IDs.
+  result = api_instance.search(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeemploymentleaveOfAbsenceTypeApi->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
+
+[**ListResponseLeaveOfAbsenceType**](ListResponseLeaveOfAbsenceType.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/EmployeeemploymentoccupationCodeApi.md

@@ -0,0 +1,73 @@
+# TripletexApi::EmployeeemploymentoccupationCodeApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](EmployeeemploymentoccupationCodeApi.md#search) | **GET** /employee/employment/occupationCode | [BETA] Find all profession codes.
+
+
+# **search**
+> ListResponseOccupationCode search(opts)
+
+[BETA] Find all profession codes.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeemploymentoccupationCodeApi.new
+
+opts = { 
+  name_no: "name_no_example", # String | Containing
+  code: "code_example", # String | Containing
+  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 profession codes.
+  result = api_instance.search(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeemploymentoccupationCodeApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_no** | **String**| Containing | [optional] 
+ **code** | **String**| Containing | [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
+
+[**ListResponseOccupationCode**](ListResponseOccupationCode.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/EmployeeemploymentremunerationTypeApi.md

@@ -0,0 +1,69 @@
+# TripletexApi::EmployeeemploymentremunerationTypeApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](EmployeeemploymentremunerationTypeApi.md#search) | **GET** /employee/employment/remunerationType | [BETA] Find all remuneration type IDs.
+
+
+# **search**
+> ListResponseRemunerationType search(opts)
+
+[BETA] Find all remuneration type IDs.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeemploymentremunerationTypeApi.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 remuneration type IDs.
+  result = api_instance.search(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeemploymentremunerationTypeApi->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
+
+[**ListResponseRemunerationType**](ListResponseRemunerationType.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/EmployeeemploymentworkingHoursSchemeApi.md

@@ -0,0 +1,69 @@
+# TripletexApi::EmployeeemploymentworkingHoursSchemeApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](EmployeeemploymentworkingHoursSchemeApi.md#search) | **GET** /employee/employment/workingHoursScheme | [BETA] Find working hours scheme ID.
+
+
+# **search**
+> ListResponseWorkingHoursScheme search(opts)
+
+[BETA] Find working hours scheme ID.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeemploymentworkingHoursSchemeApi.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 working hours scheme ID.
+  result = api_instance.search(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeemploymentworkingHoursSchemeApi->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
+
+[**ListResponseWorkingHoursScheme**](ListResponseWorkingHoursScheme.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/EmployeeentitlementApi.md

@@ -0,0 +1,313 @@
+# TripletexApi::EmployeeentitlementApi
+
+All URIs are relative to *https://tripletex.no/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**client**](EmployeeentitlementApi.md#client) | **GET** /employee/entitlement/client | [BETA] Find all entitlements at client for user.
+[**get**](EmployeeentitlementApi.md#get) | **GET** /employee/entitlement/{id} | Get entitlement by ID.
+[**grant_client_entitlements_by_template**](EmployeeentitlementApi.md#grant_client_entitlements_by_template) | **PUT** /employee/entitlement/:grantClientEntitlementsByTemplate | [BETA] Update employee entitlements in client account.
+[**grant_entitlements_by_template**](EmployeeentitlementApi.md#grant_entitlements_by_template) | **PUT** /employee/entitlement/:grantEntitlementsByTemplate | [BETA] Update employee entitlements.
+[**search**](EmployeeentitlementApi.md#search) | **GET** /employee/entitlement | Find all entitlements for user.
+
+
+# **client**
+> ListResponseEntitlement client(opts)
+
+[BETA] Find all entitlements at client for user.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeentitlementApi.new
+
+opts = { 
+  employee_id: 56, # Integer | Employee ID. Defaults to ID of token owner.
+  customer_id: 56, # Integer | Client ID
+  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 entitlements at client for user.
+  result = api_instance.client(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeentitlementApi->client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_id** | **Integer**| Employee ID. Defaults to ID of token owner. | [optional] 
+ **customer_id** | **Integer**| Client ID | [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
+
+[**ListResponseEntitlement**](ListResponseEntitlement.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **get**
+> ResponseWrapperEntitlement get(id, opts)
+
+Get entitlement by ID.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeentitlementApi.new
+
+id = 56 # Integer | Element ID
+
+opts = { 
+  fields: "fields_example" # String | Fields filter pattern
+}
+
+begin
+  #Get entitlement by ID.
+  result = api_instance.get(id, opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeentitlementApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Element ID | 
+ **fields** | **String**| Fields filter pattern | [optional] 
+
+### Return type
+
+[**ResponseWrapperEntitlement**](ResponseWrapperEntitlement.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **grant_client_entitlements_by_template**
+> grant_client_entitlements_by_template(employee_id, customer_id, template, opts)
+
+[BETA] Update employee entitlements in client account.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeentitlementApi.new
+
+employee_id = 56 # Integer | Employee ID
+
+customer_id = 56 # Integer | Client ID
+
+template = "template_example" # String | Template
+
+opts = { 
+  add_to_existing: false # BOOLEAN | Add template to existing entitlements
+}
+
+begin
+  #[BETA] Update employee entitlements in client account.
+  api_instance.grant_client_entitlements_by_template(employee_id, customer_id, template, opts)
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeentitlementApi->grant_client_entitlements_by_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_id** | **Integer**| Employee ID | 
+ **customer_id** | **Integer**| Client ID | 
+ **template** | **String**| Template | 
+ **add_to_existing** | **BOOLEAN**| Add template to existing entitlements | [optional] [default to false]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **grant_entitlements_by_template**
+> grant_entitlements_by_template(employee_id, template)
+
+[BETA] Update employee entitlements.
+
+The user will only receive the entitlements which are possible with the registered user type
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeentitlementApi.new
+
+employee_id = 56 # Integer | Employee ID
+
+template = "template_example" # String | Template
+
+
+begin
+  #[BETA] Update employee entitlements.
+  api_instance.grant_entitlements_by_template(employee_id, template)
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeentitlementApi->grant_entitlements_by_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_id** | **Integer**| Employee ID | 
+ **template** | **String**| Template | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **search**
+> ListResponseEntitlement search(opts)
+
+Find all entitlements for user.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'tripletex_api'
+# setup authorization
+TripletexApi.configure do |config|
+  # Configure HTTP basic authorization: tokenAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = TripletexApi::EmployeeentitlementApi.new
+
+opts = { 
+  employee_id: 56, # Integer | Employee ID. Defaults to ID of token owner.
+  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
+  #Find all entitlements for user.
+  result = api_instance.search(opts)
+  p result
+rescue TripletexApi::ApiError => e
+  puts "Exception when calling EmployeeentitlementApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_id** | **Integer**| Employee ID. Defaults to ID of token owner. | [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
+
+[**ListResponseEntitlement**](ListResponseEntitlement.md)
+
+### Authorization
+
+[tokenAuthScheme](../README.md#tokenAuthScheme)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+