affixapi 0.0.1

data/docs/DeveloperApi.md

@@ -0,0 +1,777 @@
+# OpenapiClient::DeveloperApi
+
+All URIs are relative to *https://api.affixapi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**developer_companies20230301**](DeveloperApi.md#developer_companies20230301) | **GET** /2023-03-01/developer/company | Company |
+| [**developer_create_employee20230301**](DeveloperApi.md#developer_create_employee20230301) | **POST** /2023-03-01/developer/employee | Create employee |
+| [**developer_employees20230301**](DeveloperApi.md#developer_employees20230301) | **GET** /2023-03-01/developer/employees | Employees |
+| [**developer_groups20230301**](DeveloperApi.md#developer_groups20230301) | **GET** /2023-03-01/developer/groups | Groups |
+| [**developer_identity20230301**](DeveloperApi.md#developer_identity20230301) | **GET** /2023-03-01/developer/identity | Identity |
+| [**developer_payruns20230301**](DeveloperApi.md#developer_payruns20230301) | **GET** /2023-03-01/developer/payruns | Payruns |
+| [**developer_payslips20230301**](DeveloperApi.md#developer_payslips20230301) | **GET** /2023-03-01/developer/payruns/{payrun_id} | Payslips |
+| [**developer_time_off_balances20230301**](DeveloperApi.md#developer_time_off_balances20230301) | **GET** /2023-03-01/developer/time-off-balances | Time off balances |
+| [**developer_time_off_entries20230301**](DeveloperApi.md#developer_time_off_entries20230301) | **GET** /2023-03-01/developer/time-off-entries | Time off entries |
+| [**developer_timesheets20230301**](DeveloperApi.md#developer_timesheets20230301) | **GET** /2023-03-01/developer/timesheets | Timesheets |
+| [**developer_work_locations20230301**](DeveloperApi.md#developer_work_locations20230301) | **GET** /2023-03-01/developer/work-locations | Work locations |
+
+
+## developer_companies20230301
+
+> <Array<CompanyResponse>> developer_companies20230301
+
+Company
+
+Retrieve company information 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Company
+  result = api_instance.developer_companies20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_companies20230301: #{e}"
+end
+```
+
+#### Using the developer_companies20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CompanyResponse>>, Integer, Hash)> developer_companies20230301_with_http_info
+
+```ruby
+begin
+  # Company
+  data, status_code, headers = api_instance.developer_companies20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CompanyResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_companies20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;CompanyResponse&gt;**](CompanyResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_create_employee20230301
+
+> <EmployeeResponse> developer_create_employee20230301(create_employee_request)
+
+Create employee
+
+Creates a new Employee 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest | 
+
+begin
+  # Create employee
+  result = api_instance.developer_create_employee20230301(create_employee_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_create_employee20230301: #{e}"
+end
+```
+
+#### Using the developer_create_employee20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmployeeResponse>, Integer, Hash)> developer_create_employee20230301_with_http_info(create_employee_request)
+
+```ruby
+begin
+  # Create employee
+  data, status_code, headers = api_instance.developer_create_employee20230301_with_http_info(create_employee_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmployeeResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_create_employee20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_employee_request** | [**CreateEmployeeRequest**](CreateEmployeeRequest.md) |  |  |
+
+### Return type
+
+[**EmployeeResponse**](EmployeeResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## developer_employees20230301
+
+> <Array<EmployeeResponse>> developer_employees20230301
+
+Employees
+
+List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Employees
+  result = api_instance.developer_employees20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_employees20230301: #{e}"
+end
+```
+
+#### Using the developer_employees20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<EmployeeResponse>>, Integer, Hash)> developer_employees20230301_with_http_info
+
+```ruby
+begin
+  # Employees
+  data, status_code, headers = api_instance.developer_employees20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<EmployeeResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_employees20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;EmployeeResponse&gt;**](EmployeeResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_groups20230301
+
+> <Array<GroupResponse>> developer_groups20230301
+
+Groups
+
+The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Groups
+  result = api_instance.developer_groups20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_groups20230301: #{e}"
+end
+```
+
+#### Using the developer_groups20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GroupResponse>>, Integer, Hash)> developer_groups20230301_with_http_info
+
+```ruby
+begin
+  # Groups
+  data, status_code, headers = api_instance.developer_groups20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GroupResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_groups20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;GroupResponse&gt;**](GroupResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_identity20230301
+
+> <IdentityResponse> developer_identity20230301
+
+Identity
+
+List information of the user for the respective account 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Identity
+  result = api_instance.developer_identity20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_identity20230301: #{e}"
+end
+```
+
+#### Using the developer_identity20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IdentityResponse>, Integer, Hash)> developer_identity20230301_with_http_info
+
+```ruby
+begin
+  # Identity
+  data, status_code, headers = api_instance.developer_identity20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IdentityResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_identity20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**IdentityResponse**](IdentityResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_payruns20230301
+
+> <Array<PayrunResponse>> developer_payruns20230301(start_date, end_date)
+
+Payruns
+
+List all the pay runs that occurred during the respective period.  Supported integrations:   - sageone   - simplepay.ie   - brightpay connect 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+start_date = Date.parse('2013-10-20') # Date | The start date of the search period
+end_date = Date.parse('2013-10-20') # Date | The end date of the search period
+
+begin
+  # Payruns
+  result = api_instance.developer_payruns20230301(start_date, end_date)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_payruns20230301: #{e}"
+end
+```
+
+#### Using the developer_payruns20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<PayrunResponse>>, Integer, Hash)> developer_payruns20230301_with_http_info(start_date, end_date)
+
+```ruby
+begin
+  # Payruns
+  data, status_code, headers = api_instance.developer_payruns20230301_with_http_info(start_date, end_date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<PayrunResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_payruns20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Date** | The start date of the search period |  |
+| **end_date** | **Date** | The end date of the search period |  |
+
+### Return type
+
+[**Array&lt;PayrunResponse&gt;**](PayrunResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_payslips20230301
+
+> <Array<PayslipResponse>> developer_payslips20230301(payrun_id)
+
+Payslips
+
+Retrieves payslips from a specific payrun.  Supported integrations:   - sageone   - simplepay.ie   - brightpay connect 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+payrun_id = 'payrun_id_example' # String | The id of the payrun.
+
+begin
+  # Payslips
+  result = api_instance.developer_payslips20230301(payrun_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_payslips20230301: #{e}"
+end
+```
+
+#### Using the developer_payslips20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<PayslipResponse>>, Integer, Hash)> developer_payslips20230301_with_http_info(payrun_id)
+
+```ruby
+begin
+  # Payslips
+  data, status_code, headers = api_instance.developer_payslips20230301_with_http_info(payrun_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<PayslipResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_payslips20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payrun_id** | **String** | The id of the payrun. |  |
+
+### Return type
+
+[**Array&lt;PayslipResponse&gt;**](PayslipResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_time_off_balances20230301
+
+> <Array<TimeOffBalanceResponse>> developer_time_off_balances20230301
+
+Time off balances
+
+Retrieve all time off balances. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Time off balances
+  result = api_instance.developer_time_off_balances20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_time_off_balances20230301: #{e}"
+end
+```
+
+#### Using the developer_time_off_balances20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> developer_time_off_balances20230301_with_http_info
+
+```ruby
+begin
+  # Time off balances
+  data, status_code, headers = api_instance.developer_time_off_balances20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TimeOffBalanceResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_time_off_balances20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;TimeOffBalanceResponse&gt;**](TimeOffBalanceResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_time_off_entries20230301
+
+> <Array<TimeOffEntryResponse>> developer_time_off_entries20230301
+
+Time off entries
+
+Retrieve time off / absence entries 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Time off entries
+  result = api_instance.developer_time_off_entries20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_time_off_entries20230301: #{e}"
+end
+```
+
+#### Using the developer_time_off_entries20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> developer_time_off_entries20230301_with_http_info
+
+```ruby
+begin
+  # Time off entries
+  data, status_code, headers = api_instance.developer_time_off_entries20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TimeOffEntryResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_time_off_entries20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;TimeOffEntryResponse&gt;**](TimeOffEntryResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_timesheets20230301
+
+> <Array<TimesheetResponse>> developer_timesheets20230301
+
+Timesheets
+
+Retrieve Timesheets 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Timesheets
+  result = api_instance.developer_timesheets20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_timesheets20230301: #{e}"
+end
+```
+
+#### Using the developer_timesheets20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TimesheetResponse>>, Integer, Hash)> developer_timesheets20230301_with_http_info
+
+```ruby
+begin
+  # Timesheets
+  data, status_code, headers = api_instance.developer_timesheets20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TimesheetResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_timesheets20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;TimesheetResponse&gt;**](TimesheetResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## developer_work_locations20230301
+
+> <Array<LocationResponse>> developer_work_locations20230301
+
+Work locations
+
+The Location object is used to represent an address that can be associated with an employee 
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: access-token
+  config.api_key['access-token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['access-token'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::DeveloperApi.new
+
+begin
+  # Work locations
+  result = api_instance.developer_work_locations20230301
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_work_locations20230301: #{e}"
+end
+```
+
+#### Using the developer_work_locations20230301_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<LocationResponse>>, Integer, Hash)> developer_work_locations20230301_with_http_info
+
+```ruby
+begin
+  # Work locations
+  data, status_code, headers = api_instance.developer_work_locations20230301_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<LocationResponse>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling DeveloperApi->developer_work_locations20230301_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;LocationResponse&gt;**](LocationResponse.md)
+
+### Authorization
+
+[access-token](../README.md#access-token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+