affixapi 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +19 -0
- data/README.md +374 -0
- data/Rakefile +10 -0
- data/affixapi.gemspec +38 -0
- data/docs/AddressNoNonNullRequest.md +26 -0
- data/docs/AddressResponse.md +26 -0
- data/docs/Class20230301Api.md +1401 -0
- data/docs/ClientRequest.md +24 -0
- data/docs/ClientResponse.md +26 -0
- data/docs/CompanyResponse.md +28 -0
- data/docs/CoreApi.md +69 -0
- data/docs/CreateEmployeeRequest.md +68 -0
- data/docs/CreateEmployeeRequestBankAccount.md +26 -0
- data/docs/CreateEmployeeRequestManager.md +26 -0
- data/docs/CurrencyRequest.md +15 -0
- data/docs/CurrencyResponse.md +15 -0
- data/docs/DeveloperApi.md +777 -0
- data/docs/DisconnectResponse.md +18 -0
- data/docs/EmployeeResponse.md +74 -0
- data/docs/EmploymentNoNullEnumRequest.md +30 -0
- data/docs/EmploymentResponse.md +30 -0
- data/docs/GroupNoNullEnumRequest.md +24 -0
- data/docs/GroupResponse.md +24 -0
- data/docs/IdAndMessageResponse.md +20 -0
- data/docs/IdentityResponse.md +22 -0
- data/docs/InlineResponse400.md +20 -0
- data/docs/InlineResponse401.md +22 -0
- data/docs/InlineResponse409.md +22 -0
- data/docs/IntrospectResponse.md +24 -0
- data/docs/LocationNoNonNullRequest.md +26 -0
- data/docs/LocationResponse.md +26 -0
- data/docs/ManagementApi.md +420 -0
- data/docs/MessageResponse.md +18 -0
- data/docs/ModeRequest.md +15 -0
- data/docs/ModeResponse.md +15 -0
- data/docs/OfficialApi.md +631 -0
- data/docs/PayrunResponse.md +30 -0
- data/docs/PayslipResponse.md +44 -0
- data/docs/PayslipResponseContributions.md +20 -0
- data/docs/PayslipResponseDeductions.md +20 -0
- data/docs/PayslipResponseEarnings.md +22 -0
- data/docs/PayslipResponseTaxes.md +22 -0
- data/docs/ProviderRequest.md +15 -0
- data/docs/ProviderResponse.md +15 -0
- data/docs/ScopesRequest.md +15 -0
- data/docs/ScopesResponse.md +15 -0
- data/docs/TimeOffBalanceResponse.md +32 -0
- data/docs/TimeOffEntryResponse.md +40 -0
- data/docs/TimesheetResponse.md +32 -0
- data/docs/TokenRequest.md +26 -0
- data/docs/TokenResponse.md +26 -0
- data/git_push.sh +58 -0
- data/lib/openapi_client/api/class20230301_api.rb +1198 -0
- data/lib/openapi_client/api/core_api.rb +79 -0
- data/lib/openapi_client/api/developer_api.rb +677 -0
- data/lib/openapi_client/api/management_api.rb +380 -0
- data/lib/openapi_client/api/official_api.rb +543 -0
- data/lib/openapi_client/api_client.rb +390 -0
- data/lib/openapi_client/api_error.rb +57 -0
- data/lib/openapi_client/configuration.rb +288 -0
- data/lib/openapi_client/models/address_no_non_null_request.rb +295 -0
- data/lib/openapi_client/models/address_response.rb +295 -0
- data/lib/openapi_client/models/client_request.rb +269 -0
- data/lib/openapi_client/models/client_response.rb +284 -0
- data/lib/openapi_client/models/company_response.rb +279 -0
- data/lib/openapi_client/models/create_employee_request.rb +568 -0
- data/lib/openapi_client/models/create_employee_request_bank_account.rb +259 -0
- data/lib/openapi_client/models/create_employee_request_manager.rb +263 -0
- data/lib/openapi_client/models/currency_request.rb +38 -0
- data/lib/openapi_client/models/currency_response.rb +38 -0
- data/lib/openapi_client/models/disconnect_response.rb +258 -0
- data/lib/openapi_client/models/employee_response.rb +608 -0
- data/lib/openapi_client/models/employment_no_null_enum_request.rb +329 -0
- data/lib/openapi_client/models/employment_response.rb +329 -0
- data/lib/openapi_client/models/group_no_null_enum_request.rb +283 -0
- data/lib/openapi_client/models/group_response.rb +283 -0
- data/lib/openapi_client/models/id_and_message_response.rb +239 -0
- data/lib/openapi_client/models/identity_response.rb +250 -0
- data/lib/openapi_client/models/inline_response400.rb +227 -0
- data/lib/openapi_client/models/inline_response401.rb +299 -0
- data/lib/openapi_client/models/inline_response409.rb +278 -0
- data/lib/openapi_client/models/introspect_response.rb +269 -0
- data/lib/openapi_client/models/location_no_non_null_request.rb +263 -0
- data/lib/openapi_client/models/location_response.rb +263 -0
- data/lib/openapi_client/models/message_response.rb +223 -0
- data/lib/openapi_client/models/mode_request.rb +37 -0
- data/lib/openapi_client/models/mode_response.rb +37 -0
- data/lib/openapi_client/models/payrun_response.rb +342 -0
- data/lib/openapi_client/models/payslip_response.rb +448 -0
- data/lib/openapi_client/models/payslip_response_contributions.rb +238 -0
- data/lib/openapi_client/models/payslip_response_deductions.rb +238 -0
- data/lib/openapi_client/models/payslip_response_earnings.rb +250 -0
- data/lib/openapi_client/models/payslip_response_taxes.rb +248 -0
- data/lib/openapi_client/models/provider_request.rb +70 -0
- data/lib/openapi_client/models/provider_response.rb +70 -0
- data/lib/openapi_client/models/scopes_request.rb +55 -0
- data/lib/openapi_client/models/scopes_response.rb +55 -0
- data/lib/openapi_client/models/time_off_balance_response.rb +342 -0
- data/lib/openapi_client/models/time_off_entry_response.rb +408 -0
- data/lib/openapi_client/models/timesheet_response.rb +318 -0
- data/lib/openapi_client/models/token_request.rb +318 -0
- data/lib/openapi_client/models/token_response.rb +318 -0
- data/lib/openapi_client/version.rb +15 -0
- data/lib/openapi_client.rb +86 -0
- data/openapi_client-0.0.1.gem +0 -0
- data/pkg/affixapi-0.0.1.gem +0 -0
- data/spec/api/class20230301_api_spec.rb +260 -0
- data/spec/api/core_api_spec.rb +46 -0
- data/spec/api/developer_api_spec.rb +160 -0
- data/spec/api/management_api_spec.rb +103 -0
- data/spec/api/official_api_spec.rb +135 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/address_no_non_null_request_spec.rb +62 -0
- data/spec/models/address_response_spec.rb +62 -0
- data/spec/models/client_request_spec.rb +52 -0
- data/spec/models/client_response_spec.rb +58 -0
- data/spec/models/company_response_spec.rb +64 -0
- data/spec/models/create_employee_request_bank_account_spec.rb +58 -0
- data/spec/models/create_employee_request_manager_spec.rb +58 -0
- data/spec/models/create_employee_request_spec.rb +204 -0
- data/spec/models/currency_request_spec.rb +28 -0
- data/spec/models/currency_response_spec.rb +28 -0
- data/spec/models/disconnect_response_spec.rb +38 -0
- data/spec/models/employee_response_spec.rb +222 -0
- data/spec/models/employment_no_null_enum_request_spec.rb +78 -0
- data/spec/models/employment_response_spec.rb +78 -0
- data/spec/models/group_no_null_enum_request_spec.rb +56 -0
- data/spec/models/group_response_spec.rb +56 -0
- data/spec/models/id_and_message_response_spec.rb +40 -0
- data/spec/models/identity_response_spec.rb +46 -0
- data/spec/models/inline_response400_spec.rb +40 -0
- data/spec/models/inline_response401_spec.rb +54 -0
- data/spec/models/inline_response409_spec.rb +50 -0
- data/spec/models/introspect_response_spec.rb +52 -0
- data/spec/models/location_no_non_null_request_spec.rb +58 -0
- data/spec/models/location_response_spec.rb +58 -0
- data/spec/models/message_response_spec.rb +34 -0
- data/spec/models/mode_request_spec.rb +28 -0
- data/spec/models/mode_response_spec.rb +28 -0
- data/spec/models/payrun_response_spec.rb +78 -0
- data/spec/models/payslip_response_contributions_spec.rb +40 -0
- data/spec/models/payslip_response_deductions_spec.rb +40 -0
- data/spec/models/payslip_response_earnings_spec.rb +46 -0
- data/spec/models/payslip_response_spec.rb +116 -0
- data/spec/models/payslip_response_taxes_spec.rb +46 -0
- data/spec/models/provider_request_spec.rb +28 -0
- data/spec/models/provider_response_spec.rb +28 -0
- data/spec/models/scopes_request_spec.rb +28 -0
- data/spec/models/scopes_response_spec.rb +28 -0
- data/spec/models/time_off_balance_response_spec.rb +80 -0
- data/spec/models/time_off_entry_response_spec.rb +108 -0
- data/spec/models/timesheet_response_spec.rb +76 -0
- data/spec/models/token_request_spec.rb +62 -0
- data/spec/models/token_response_spec.rb +62 -0
- data/spec/spec_helper.rb +111 -0
- metadata +349 -0
@@ -0,0 +1,1401 @@
|
|
1
|
+
# OpenapiClient::Class20230301Api
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.affixapi.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**developer_companies20230301**](Class20230301Api.md#developer_companies20230301) | **GET** /2023-03-01/developer/company | Company |
|
8
|
+
| [**developer_create_employee20230301**](Class20230301Api.md#developer_create_employee20230301) | **POST** /2023-03-01/developer/employee | Create employee |
|
9
|
+
| [**developer_employees20230301**](Class20230301Api.md#developer_employees20230301) | **GET** /2023-03-01/developer/employees | Employees |
|
10
|
+
| [**developer_groups20230301**](Class20230301Api.md#developer_groups20230301) | **GET** /2023-03-01/developer/groups | Groups |
|
11
|
+
| [**developer_identity20230301**](Class20230301Api.md#developer_identity20230301) | **GET** /2023-03-01/developer/identity | Identity |
|
12
|
+
| [**developer_payruns20230301**](Class20230301Api.md#developer_payruns20230301) | **GET** /2023-03-01/developer/payruns | Payruns |
|
13
|
+
| [**developer_payslips20230301**](Class20230301Api.md#developer_payslips20230301) | **GET** /2023-03-01/developer/payruns/{payrun_id} | Payslips |
|
14
|
+
| [**developer_time_off_balances20230301**](Class20230301Api.md#developer_time_off_balances20230301) | **GET** /2023-03-01/developer/time-off-balances | Time off balances |
|
15
|
+
| [**developer_time_off_entries20230301**](Class20230301Api.md#developer_time_off_entries20230301) | **GET** /2023-03-01/developer/time-off-entries | Time off entries |
|
16
|
+
| [**developer_timesheets20230301**](Class20230301Api.md#developer_timesheets20230301) | **GET** /2023-03-01/developer/timesheets | Timesheets |
|
17
|
+
| [**developer_work_locations20230301**](Class20230301Api.md#developer_work_locations20230301) | **GET** /2023-03-01/developer/work-locations | Work locations |
|
18
|
+
| [**official_companies20230301**](Class20230301Api.md#official_companies20230301) | **GET** /2023-03-01/official/company | Company |
|
19
|
+
| [**official_create_employee20230301**](Class20230301Api.md#official_create_employee20230301) | **POST** /2023-03-01/official/employee | Create Employee |
|
20
|
+
| [**official_employees20230301**](Class20230301Api.md#official_employees20230301) | **GET** /2023-03-01/official/employees | Employees |
|
21
|
+
| [**official_groups20230301**](Class20230301Api.md#official_groups20230301) | **GET** /2023-03-01/official/groups | Groups |
|
22
|
+
| [**official_time_off_balances20230301**](Class20230301Api.md#official_time_off_balances20230301) | **GET** /2023-03-01/official/time-off-balances | Time off balances |
|
23
|
+
| [**official_time_off_entries20230301**](Class20230301Api.md#official_time_off_entries20230301) | **GET** /2023-03-01/official/time-off-entries | Time off entries |
|
24
|
+
| [**official_timesheets20230301**](Class20230301Api.md#official_timesheets20230301) | **GET** /2023-03-01/official/timesheets | Timesheets |
|
25
|
+
| [**official_work_locations20230301**](Class20230301Api.md#official_work_locations20230301) | **GET** /2023-03-01/official/work-locations | Work locations |
|
26
|
+
| [**officialdentity20230301**](Class20230301Api.md#officialdentity20230301) | **GET** /2023-03-01/official/identity | Identity |
|
27
|
+
|
28
|
+
|
29
|
+
## developer_companies20230301
|
30
|
+
|
31
|
+
> <Array<CompanyResponse>> developer_companies20230301
|
32
|
+
|
33
|
+
Company
|
34
|
+
|
35
|
+
Retrieve company information
|
36
|
+
|
37
|
+
### Examples
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
require 'time'
|
41
|
+
require 'openapi_client'
|
42
|
+
# setup authorization
|
43
|
+
OpenapiClient.configure do |config|
|
44
|
+
# Configure API key authorization: access-token
|
45
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
46
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
47
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
48
|
+
end
|
49
|
+
|
50
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
51
|
+
|
52
|
+
begin
|
53
|
+
# Company
|
54
|
+
result = api_instance.developer_companies20230301
|
55
|
+
p result
|
56
|
+
rescue OpenapiClient::ApiError => e
|
57
|
+
puts "Error when calling Class20230301Api->developer_companies20230301: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
#### Using the developer_companies20230301_with_http_info variant
|
62
|
+
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
64
|
+
|
65
|
+
> <Array(<Array<CompanyResponse>>, Integer, Hash)> developer_companies20230301_with_http_info
|
66
|
+
|
67
|
+
```ruby
|
68
|
+
begin
|
69
|
+
# Company
|
70
|
+
data, status_code, headers = api_instance.developer_companies20230301_with_http_info
|
71
|
+
p status_code # => 2xx
|
72
|
+
p headers # => { ... }
|
73
|
+
p data # => <Array<CompanyResponse>>
|
74
|
+
rescue OpenapiClient::ApiError => e
|
75
|
+
puts "Error when calling Class20230301Api->developer_companies20230301_with_http_info: #{e}"
|
76
|
+
end
|
77
|
+
```
|
78
|
+
|
79
|
+
### Parameters
|
80
|
+
|
81
|
+
This endpoint does not need any parameter.
|
82
|
+
|
83
|
+
### Return type
|
84
|
+
|
85
|
+
[**Array<CompanyResponse>**](CompanyResponse.md)
|
86
|
+
|
87
|
+
### Authorization
|
88
|
+
|
89
|
+
[access-token](../README.md#access-token)
|
90
|
+
|
91
|
+
### HTTP request headers
|
92
|
+
|
93
|
+
- **Content-Type**: Not defined
|
94
|
+
- **Accept**: application/json
|
95
|
+
|
96
|
+
|
97
|
+
## developer_create_employee20230301
|
98
|
+
|
99
|
+
> <EmployeeResponse> developer_create_employee20230301(create_employee_request)
|
100
|
+
|
101
|
+
Create employee
|
102
|
+
|
103
|
+
Creates a new Employee
|
104
|
+
|
105
|
+
### Examples
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
require 'time'
|
109
|
+
require 'openapi_client'
|
110
|
+
# setup authorization
|
111
|
+
OpenapiClient.configure do |config|
|
112
|
+
# Configure API key authorization: access-token
|
113
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
115
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
116
|
+
end
|
117
|
+
|
118
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
119
|
+
create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest |
|
120
|
+
|
121
|
+
begin
|
122
|
+
# Create employee
|
123
|
+
result = api_instance.developer_create_employee20230301(create_employee_request)
|
124
|
+
p result
|
125
|
+
rescue OpenapiClient::ApiError => e
|
126
|
+
puts "Error when calling Class20230301Api->developer_create_employee20230301: #{e}"
|
127
|
+
end
|
128
|
+
```
|
129
|
+
|
130
|
+
#### Using the developer_create_employee20230301_with_http_info variant
|
131
|
+
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
133
|
+
|
134
|
+
> <Array(<EmployeeResponse>, Integer, Hash)> developer_create_employee20230301_with_http_info(create_employee_request)
|
135
|
+
|
136
|
+
```ruby
|
137
|
+
begin
|
138
|
+
# Create employee
|
139
|
+
data, status_code, headers = api_instance.developer_create_employee20230301_with_http_info(create_employee_request)
|
140
|
+
p status_code # => 2xx
|
141
|
+
p headers # => { ... }
|
142
|
+
p data # => <EmployeeResponse>
|
143
|
+
rescue OpenapiClient::ApiError => e
|
144
|
+
puts "Error when calling Class20230301Api->developer_create_employee20230301_with_http_info: #{e}"
|
145
|
+
end
|
146
|
+
```
|
147
|
+
|
148
|
+
### Parameters
|
149
|
+
|
150
|
+
| Name | Type | Description | Notes |
|
151
|
+
| ---- | ---- | ----------- | ----- |
|
152
|
+
| **create_employee_request** | [**CreateEmployeeRequest**](CreateEmployeeRequest.md) | | |
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
[**EmployeeResponse**](EmployeeResponse.md)
|
157
|
+
|
158
|
+
### Authorization
|
159
|
+
|
160
|
+
[access-token](../README.md#access-token)
|
161
|
+
|
162
|
+
### HTTP request headers
|
163
|
+
|
164
|
+
- **Content-Type**: application/json
|
165
|
+
- **Accept**: application/json
|
166
|
+
|
167
|
+
|
168
|
+
## developer_employees20230301
|
169
|
+
|
170
|
+
> <Array<EmployeeResponse>> developer_employees20230301
|
171
|
+
|
172
|
+
Employees
|
173
|
+
|
174
|
+
List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
175
|
+
|
176
|
+
### Examples
|
177
|
+
|
178
|
+
```ruby
|
179
|
+
require 'time'
|
180
|
+
require 'openapi_client'
|
181
|
+
# setup authorization
|
182
|
+
OpenapiClient.configure do |config|
|
183
|
+
# Configure API key authorization: access-token
|
184
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
185
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
186
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
187
|
+
end
|
188
|
+
|
189
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
190
|
+
|
191
|
+
begin
|
192
|
+
# Employees
|
193
|
+
result = api_instance.developer_employees20230301
|
194
|
+
p result
|
195
|
+
rescue OpenapiClient::ApiError => e
|
196
|
+
puts "Error when calling Class20230301Api->developer_employees20230301: #{e}"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
#### Using the developer_employees20230301_with_http_info variant
|
201
|
+
|
202
|
+
This returns an Array which contains the response data, status code and headers.
|
203
|
+
|
204
|
+
> <Array(<Array<EmployeeResponse>>, Integer, Hash)> developer_employees20230301_with_http_info
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
begin
|
208
|
+
# Employees
|
209
|
+
data, status_code, headers = api_instance.developer_employees20230301_with_http_info
|
210
|
+
p status_code # => 2xx
|
211
|
+
p headers # => { ... }
|
212
|
+
p data # => <Array<EmployeeResponse>>
|
213
|
+
rescue OpenapiClient::ApiError => e
|
214
|
+
puts "Error when calling Class20230301Api->developer_employees20230301_with_http_info: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
### Parameters
|
219
|
+
|
220
|
+
This endpoint does not need any parameter.
|
221
|
+
|
222
|
+
### Return type
|
223
|
+
|
224
|
+
[**Array<EmployeeResponse>**](EmployeeResponse.md)
|
225
|
+
|
226
|
+
### Authorization
|
227
|
+
|
228
|
+
[access-token](../README.md#access-token)
|
229
|
+
|
230
|
+
### HTTP request headers
|
231
|
+
|
232
|
+
- **Content-Type**: Not defined
|
233
|
+
- **Accept**: application/json
|
234
|
+
|
235
|
+
|
236
|
+
## developer_groups20230301
|
237
|
+
|
238
|
+
> <Array<GroupResponse>> developer_groups20230301
|
239
|
+
|
240
|
+
Groups
|
241
|
+
|
242
|
+
The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
243
|
+
|
244
|
+
### Examples
|
245
|
+
|
246
|
+
```ruby
|
247
|
+
require 'time'
|
248
|
+
require 'openapi_client'
|
249
|
+
# setup authorization
|
250
|
+
OpenapiClient.configure do |config|
|
251
|
+
# Configure API key authorization: access-token
|
252
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
253
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
254
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
255
|
+
end
|
256
|
+
|
257
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
258
|
+
|
259
|
+
begin
|
260
|
+
# Groups
|
261
|
+
result = api_instance.developer_groups20230301
|
262
|
+
p result
|
263
|
+
rescue OpenapiClient::ApiError => e
|
264
|
+
puts "Error when calling Class20230301Api->developer_groups20230301: #{e}"
|
265
|
+
end
|
266
|
+
```
|
267
|
+
|
268
|
+
#### Using the developer_groups20230301_with_http_info variant
|
269
|
+
|
270
|
+
This returns an Array which contains the response data, status code and headers.
|
271
|
+
|
272
|
+
> <Array(<Array<GroupResponse>>, Integer, Hash)> developer_groups20230301_with_http_info
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
begin
|
276
|
+
# Groups
|
277
|
+
data, status_code, headers = api_instance.developer_groups20230301_with_http_info
|
278
|
+
p status_code # => 2xx
|
279
|
+
p headers # => { ... }
|
280
|
+
p data # => <Array<GroupResponse>>
|
281
|
+
rescue OpenapiClient::ApiError => e
|
282
|
+
puts "Error when calling Class20230301Api->developer_groups20230301_with_http_info: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
This endpoint does not need any parameter.
|
289
|
+
|
290
|
+
### Return type
|
291
|
+
|
292
|
+
[**Array<GroupResponse>**](GroupResponse.md)
|
293
|
+
|
294
|
+
### Authorization
|
295
|
+
|
296
|
+
[access-token](../README.md#access-token)
|
297
|
+
|
298
|
+
### HTTP request headers
|
299
|
+
|
300
|
+
- **Content-Type**: Not defined
|
301
|
+
- **Accept**: application/json
|
302
|
+
|
303
|
+
|
304
|
+
## developer_identity20230301
|
305
|
+
|
306
|
+
> <IdentityResponse> developer_identity20230301
|
307
|
+
|
308
|
+
Identity
|
309
|
+
|
310
|
+
List information of the user for the respective account
|
311
|
+
|
312
|
+
### Examples
|
313
|
+
|
314
|
+
```ruby
|
315
|
+
require 'time'
|
316
|
+
require 'openapi_client'
|
317
|
+
# setup authorization
|
318
|
+
OpenapiClient.configure do |config|
|
319
|
+
# Configure API key authorization: access-token
|
320
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
321
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
322
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
323
|
+
end
|
324
|
+
|
325
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
326
|
+
|
327
|
+
begin
|
328
|
+
# Identity
|
329
|
+
result = api_instance.developer_identity20230301
|
330
|
+
p result
|
331
|
+
rescue OpenapiClient::ApiError => e
|
332
|
+
puts "Error when calling Class20230301Api->developer_identity20230301: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
#### Using the developer_identity20230301_with_http_info variant
|
337
|
+
|
338
|
+
This returns an Array which contains the response data, status code and headers.
|
339
|
+
|
340
|
+
> <Array(<IdentityResponse>, Integer, Hash)> developer_identity20230301_with_http_info
|
341
|
+
|
342
|
+
```ruby
|
343
|
+
begin
|
344
|
+
# Identity
|
345
|
+
data, status_code, headers = api_instance.developer_identity20230301_with_http_info
|
346
|
+
p status_code # => 2xx
|
347
|
+
p headers # => { ... }
|
348
|
+
p data # => <IdentityResponse>
|
349
|
+
rescue OpenapiClient::ApiError => e
|
350
|
+
puts "Error when calling Class20230301Api->developer_identity20230301_with_http_info: #{e}"
|
351
|
+
end
|
352
|
+
```
|
353
|
+
|
354
|
+
### Parameters
|
355
|
+
|
356
|
+
This endpoint does not need any parameter.
|
357
|
+
|
358
|
+
### Return type
|
359
|
+
|
360
|
+
[**IdentityResponse**](IdentityResponse.md)
|
361
|
+
|
362
|
+
### Authorization
|
363
|
+
|
364
|
+
[access-token](../README.md#access-token)
|
365
|
+
|
366
|
+
### HTTP request headers
|
367
|
+
|
368
|
+
- **Content-Type**: Not defined
|
369
|
+
- **Accept**: application/json
|
370
|
+
|
371
|
+
|
372
|
+
## developer_payruns20230301
|
373
|
+
|
374
|
+
> <Array<PayrunResponse>> developer_payruns20230301(start_date, end_date)
|
375
|
+
|
376
|
+
Payruns
|
377
|
+
|
378
|
+
List all the pay runs that occurred during the respective period. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
379
|
+
|
380
|
+
### Examples
|
381
|
+
|
382
|
+
```ruby
|
383
|
+
require 'time'
|
384
|
+
require 'openapi_client'
|
385
|
+
# setup authorization
|
386
|
+
OpenapiClient.configure do |config|
|
387
|
+
# Configure API key authorization: access-token
|
388
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
389
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
390
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
391
|
+
end
|
392
|
+
|
393
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
394
|
+
start_date = Date.parse('2013-10-20') # Date | The start date of the search period
|
395
|
+
end_date = Date.parse('2013-10-20') # Date | The end date of the search period
|
396
|
+
|
397
|
+
begin
|
398
|
+
# Payruns
|
399
|
+
result = api_instance.developer_payruns20230301(start_date, end_date)
|
400
|
+
p result
|
401
|
+
rescue OpenapiClient::ApiError => e
|
402
|
+
puts "Error when calling Class20230301Api->developer_payruns20230301: #{e}"
|
403
|
+
end
|
404
|
+
```
|
405
|
+
|
406
|
+
#### Using the developer_payruns20230301_with_http_info variant
|
407
|
+
|
408
|
+
This returns an Array which contains the response data, status code and headers.
|
409
|
+
|
410
|
+
> <Array(<Array<PayrunResponse>>, Integer, Hash)> developer_payruns20230301_with_http_info(start_date, end_date)
|
411
|
+
|
412
|
+
```ruby
|
413
|
+
begin
|
414
|
+
# Payruns
|
415
|
+
data, status_code, headers = api_instance.developer_payruns20230301_with_http_info(start_date, end_date)
|
416
|
+
p status_code # => 2xx
|
417
|
+
p headers # => { ... }
|
418
|
+
p data # => <Array<PayrunResponse>>
|
419
|
+
rescue OpenapiClient::ApiError => e
|
420
|
+
puts "Error when calling Class20230301Api->developer_payruns20230301_with_http_info: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
| Name | Type | Description | Notes |
|
427
|
+
| ---- | ---- | ----------- | ----- |
|
428
|
+
| **start_date** | **Date** | The start date of the search period | |
|
429
|
+
| **end_date** | **Date** | The end date of the search period | |
|
430
|
+
|
431
|
+
### Return type
|
432
|
+
|
433
|
+
[**Array<PayrunResponse>**](PayrunResponse.md)
|
434
|
+
|
435
|
+
### Authorization
|
436
|
+
|
437
|
+
[access-token](../README.md#access-token)
|
438
|
+
|
439
|
+
### HTTP request headers
|
440
|
+
|
441
|
+
- **Content-Type**: Not defined
|
442
|
+
- **Accept**: application/json
|
443
|
+
|
444
|
+
|
445
|
+
## developer_payslips20230301
|
446
|
+
|
447
|
+
> <Array<PayslipResponse>> developer_payslips20230301(payrun_id)
|
448
|
+
|
449
|
+
Payslips
|
450
|
+
|
451
|
+
Retrieves payslips from a specific payrun. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
452
|
+
|
453
|
+
### Examples
|
454
|
+
|
455
|
+
```ruby
|
456
|
+
require 'time'
|
457
|
+
require 'openapi_client'
|
458
|
+
# setup authorization
|
459
|
+
OpenapiClient.configure do |config|
|
460
|
+
# Configure API key authorization: access-token
|
461
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
462
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
463
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
464
|
+
end
|
465
|
+
|
466
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
467
|
+
payrun_id = 'payrun_id_example' # String | The id of the payrun.
|
468
|
+
|
469
|
+
begin
|
470
|
+
# Payslips
|
471
|
+
result = api_instance.developer_payslips20230301(payrun_id)
|
472
|
+
p result
|
473
|
+
rescue OpenapiClient::ApiError => e
|
474
|
+
puts "Error when calling Class20230301Api->developer_payslips20230301: #{e}"
|
475
|
+
end
|
476
|
+
```
|
477
|
+
|
478
|
+
#### Using the developer_payslips20230301_with_http_info variant
|
479
|
+
|
480
|
+
This returns an Array which contains the response data, status code and headers.
|
481
|
+
|
482
|
+
> <Array(<Array<PayslipResponse>>, Integer, Hash)> developer_payslips20230301_with_http_info(payrun_id)
|
483
|
+
|
484
|
+
```ruby
|
485
|
+
begin
|
486
|
+
# Payslips
|
487
|
+
data, status_code, headers = api_instance.developer_payslips20230301_with_http_info(payrun_id)
|
488
|
+
p status_code # => 2xx
|
489
|
+
p headers # => { ... }
|
490
|
+
p data # => <Array<PayslipResponse>>
|
491
|
+
rescue OpenapiClient::ApiError => e
|
492
|
+
puts "Error when calling Class20230301Api->developer_payslips20230301_with_http_info: #{e}"
|
493
|
+
end
|
494
|
+
```
|
495
|
+
|
496
|
+
### Parameters
|
497
|
+
|
498
|
+
| Name | Type | Description | Notes |
|
499
|
+
| ---- | ---- | ----------- | ----- |
|
500
|
+
| **payrun_id** | **String** | The id of the payrun. | |
|
501
|
+
|
502
|
+
### Return type
|
503
|
+
|
504
|
+
[**Array<PayslipResponse>**](PayslipResponse.md)
|
505
|
+
|
506
|
+
### Authorization
|
507
|
+
|
508
|
+
[access-token](../README.md#access-token)
|
509
|
+
|
510
|
+
### HTTP request headers
|
511
|
+
|
512
|
+
- **Content-Type**: Not defined
|
513
|
+
- **Accept**: application/json
|
514
|
+
|
515
|
+
|
516
|
+
## developer_time_off_balances20230301
|
517
|
+
|
518
|
+
> <Array<TimeOffBalanceResponse>> developer_time_off_balances20230301
|
519
|
+
|
520
|
+
Time off balances
|
521
|
+
|
522
|
+
Retrieve all time off balances.
|
523
|
+
|
524
|
+
### Examples
|
525
|
+
|
526
|
+
```ruby
|
527
|
+
require 'time'
|
528
|
+
require 'openapi_client'
|
529
|
+
# setup authorization
|
530
|
+
OpenapiClient.configure do |config|
|
531
|
+
# Configure API key authorization: access-token
|
532
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
533
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
534
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
535
|
+
end
|
536
|
+
|
537
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
538
|
+
|
539
|
+
begin
|
540
|
+
# Time off balances
|
541
|
+
result = api_instance.developer_time_off_balances20230301
|
542
|
+
p result
|
543
|
+
rescue OpenapiClient::ApiError => e
|
544
|
+
puts "Error when calling Class20230301Api->developer_time_off_balances20230301: #{e}"
|
545
|
+
end
|
546
|
+
```
|
547
|
+
|
548
|
+
#### Using the developer_time_off_balances20230301_with_http_info variant
|
549
|
+
|
550
|
+
This returns an Array which contains the response data, status code and headers.
|
551
|
+
|
552
|
+
> <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> developer_time_off_balances20230301_with_http_info
|
553
|
+
|
554
|
+
```ruby
|
555
|
+
begin
|
556
|
+
# Time off balances
|
557
|
+
data, status_code, headers = api_instance.developer_time_off_balances20230301_with_http_info
|
558
|
+
p status_code # => 2xx
|
559
|
+
p headers # => { ... }
|
560
|
+
p data # => <Array<TimeOffBalanceResponse>>
|
561
|
+
rescue OpenapiClient::ApiError => e
|
562
|
+
puts "Error when calling Class20230301Api->developer_time_off_balances20230301_with_http_info: #{e}"
|
563
|
+
end
|
564
|
+
```
|
565
|
+
|
566
|
+
### Parameters
|
567
|
+
|
568
|
+
This endpoint does not need any parameter.
|
569
|
+
|
570
|
+
### Return type
|
571
|
+
|
572
|
+
[**Array<TimeOffBalanceResponse>**](TimeOffBalanceResponse.md)
|
573
|
+
|
574
|
+
### Authorization
|
575
|
+
|
576
|
+
[access-token](../README.md#access-token)
|
577
|
+
|
578
|
+
### HTTP request headers
|
579
|
+
|
580
|
+
- **Content-Type**: Not defined
|
581
|
+
- **Accept**: application/json
|
582
|
+
|
583
|
+
|
584
|
+
## developer_time_off_entries20230301
|
585
|
+
|
586
|
+
> <Array<TimeOffEntryResponse>> developer_time_off_entries20230301
|
587
|
+
|
588
|
+
Time off entries
|
589
|
+
|
590
|
+
Retrieve time off / absence entries
|
591
|
+
|
592
|
+
### Examples
|
593
|
+
|
594
|
+
```ruby
|
595
|
+
require 'time'
|
596
|
+
require 'openapi_client'
|
597
|
+
# setup authorization
|
598
|
+
OpenapiClient.configure do |config|
|
599
|
+
# Configure API key authorization: access-token
|
600
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
601
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
602
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
603
|
+
end
|
604
|
+
|
605
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
606
|
+
|
607
|
+
begin
|
608
|
+
# Time off entries
|
609
|
+
result = api_instance.developer_time_off_entries20230301
|
610
|
+
p result
|
611
|
+
rescue OpenapiClient::ApiError => e
|
612
|
+
puts "Error when calling Class20230301Api->developer_time_off_entries20230301: #{e}"
|
613
|
+
end
|
614
|
+
```
|
615
|
+
|
616
|
+
#### Using the developer_time_off_entries20230301_with_http_info variant
|
617
|
+
|
618
|
+
This returns an Array which contains the response data, status code and headers.
|
619
|
+
|
620
|
+
> <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> developer_time_off_entries20230301_with_http_info
|
621
|
+
|
622
|
+
```ruby
|
623
|
+
begin
|
624
|
+
# Time off entries
|
625
|
+
data, status_code, headers = api_instance.developer_time_off_entries20230301_with_http_info
|
626
|
+
p status_code # => 2xx
|
627
|
+
p headers # => { ... }
|
628
|
+
p data # => <Array<TimeOffEntryResponse>>
|
629
|
+
rescue OpenapiClient::ApiError => e
|
630
|
+
puts "Error when calling Class20230301Api->developer_time_off_entries20230301_with_http_info: #{e}"
|
631
|
+
end
|
632
|
+
```
|
633
|
+
|
634
|
+
### Parameters
|
635
|
+
|
636
|
+
This endpoint does not need any parameter.
|
637
|
+
|
638
|
+
### Return type
|
639
|
+
|
640
|
+
[**Array<TimeOffEntryResponse>**](TimeOffEntryResponse.md)
|
641
|
+
|
642
|
+
### Authorization
|
643
|
+
|
644
|
+
[access-token](../README.md#access-token)
|
645
|
+
|
646
|
+
### HTTP request headers
|
647
|
+
|
648
|
+
- **Content-Type**: Not defined
|
649
|
+
- **Accept**: application/json
|
650
|
+
|
651
|
+
|
652
|
+
## developer_timesheets20230301
|
653
|
+
|
654
|
+
> <Array<TimesheetResponse>> developer_timesheets20230301
|
655
|
+
|
656
|
+
Timesheets
|
657
|
+
|
658
|
+
Retrieve Timesheets
|
659
|
+
|
660
|
+
### Examples
|
661
|
+
|
662
|
+
```ruby
|
663
|
+
require 'time'
|
664
|
+
require 'openapi_client'
|
665
|
+
# setup authorization
|
666
|
+
OpenapiClient.configure do |config|
|
667
|
+
# Configure API key authorization: access-token
|
668
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
669
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
670
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
671
|
+
end
|
672
|
+
|
673
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
674
|
+
|
675
|
+
begin
|
676
|
+
# Timesheets
|
677
|
+
result = api_instance.developer_timesheets20230301
|
678
|
+
p result
|
679
|
+
rescue OpenapiClient::ApiError => e
|
680
|
+
puts "Error when calling Class20230301Api->developer_timesheets20230301: #{e}"
|
681
|
+
end
|
682
|
+
```
|
683
|
+
|
684
|
+
#### Using the developer_timesheets20230301_with_http_info variant
|
685
|
+
|
686
|
+
This returns an Array which contains the response data, status code and headers.
|
687
|
+
|
688
|
+
> <Array(<Array<TimesheetResponse>>, Integer, Hash)> developer_timesheets20230301_with_http_info
|
689
|
+
|
690
|
+
```ruby
|
691
|
+
begin
|
692
|
+
# Timesheets
|
693
|
+
data, status_code, headers = api_instance.developer_timesheets20230301_with_http_info
|
694
|
+
p status_code # => 2xx
|
695
|
+
p headers # => { ... }
|
696
|
+
p data # => <Array<TimesheetResponse>>
|
697
|
+
rescue OpenapiClient::ApiError => e
|
698
|
+
puts "Error when calling Class20230301Api->developer_timesheets20230301_with_http_info: #{e}"
|
699
|
+
end
|
700
|
+
```
|
701
|
+
|
702
|
+
### Parameters
|
703
|
+
|
704
|
+
This endpoint does not need any parameter.
|
705
|
+
|
706
|
+
### Return type
|
707
|
+
|
708
|
+
[**Array<TimesheetResponse>**](TimesheetResponse.md)
|
709
|
+
|
710
|
+
### Authorization
|
711
|
+
|
712
|
+
[access-token](../README.md#access-token)
|
713
|
+
|
714
|
+
### HTTP request headers
|
715
|
+
|
716
|
+
- **Content-Type**: Not defined
|
717
|
+
- **Accept**: application/json
|
718
|
+
|
719
|
+
|
720
|
+
## developer_work_locations20230301
|
721
|
+
|
722
|
+
> <Array<LocationResponse>> developer_work_locations20230301
|
723
|
+
|
724
|
+
Work locations
|
725
|
+
|
726
|
+
The Location object is used to represent an address that can be associated with an employee
|
727
|
+
|
728
|
+
### Examples
|
729
|
+
|
730
|
+
```ruby
|
731
|
+
require 'time'
|
732
|
+
require 'openapi_client'
|
733
|
+
# setup authorization
|
734
|
+
OpenapiClient.configure do |config|
|
735
|
+
# Configure API key authorization: access-token
|
736
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
737
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
738
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
739
|
+
end
|
740
|
+
|
741
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
742
|
+
|
743
|
+
begin
|
744
|
+
# Work locations
|
745
|
+
result = api_instance.developer_work_locations20230301
|
746
|
+
p result
|
747
|
+
rescue OpenapiClient::ApiError => e
|
748
|
+
puts "Error when calling Class20230301Api->developer_work_locations20230301: #{e}"
|
749
|
+
end
|
750
|
+
```
|
751
|
+
|
752
|
+
#### Using the developer_work_locations20230301_with_http_info variant
|
753
|
+
|
754
|
+
This returns an Array which contains the response data, status code and headers.
|
755
|
+
|
756
|
+
> <Array(<Array<LocationResponse>>, Integer, Hash)> developer_work_locations20230301_with_http_info
|
757
|
+
|
758
|
+
```ruby
|
759
|
+
begin
|
760
|
+
# Work locations
|
761
|
+
data, status_code, headers = api_instance.developer_work_locations20230301_with_http_info
|
762
|
+
p status_code # => 2xx
|
763
|
+
p headers # => { ... }
|
764
|
+
p data # => <Array<LocationResponse>>
|
765
|
+
rescue OpenapiClient::ApiError => e
|
766
|
+
puts "Error when calling Class20230301Api->developer_work_locations20230301_with_http_info: #{e}"
|
767
|
+
end
|
768
|
+
```
|
769
|
+
|
770
|
+
### Parameters
|
771
|
+
|
772
|
+
This endpoint does not need any parameter.
|
773
|
+
|
774
|
+
### Return type
|
775
|
+
|
776
|
+
[**Array<LocationResponse>**](LocationResponse.md)
|
777
|
+
|
778
|
+
### Authorization
|
779
|
+
|
780
|
+
[access-token](../README.md#access-token)
|
781
|
+
|
782
|
+
### HTTP request headers
|
783
|
+
|
784
|
+
- **Content-Type**: Not defined
|
785
|
+
- **Accept**: application/json
|
786
|
+
|
787
|
+
|
788
|
+
## official_companies20230301
|
789
|
+
|
790
|
+
> <Array<CompanyResponse>> official_companies20230301
|
791
|
+
|
792
|
+
Company
|
793
|
+
|
794
|
+
Retrieve company information
|
795
|
+
|
796
|
+
### Examples
|
797
|
+
|
798
|
+
```ruby
|
799
|
+
require 'time'
|
800
|
+
require 'openapi_client'
|
801
|
+
# setup authorization
|
802
|
+
OpenapiClient.configure do |config|
|
803
|
+
# Configure API key authorization: access-token
|
804
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
805
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
806
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
807
|
+
end
|
808
|
+
|
809
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
810
|
+
|
811
|
+
begin
|
812
|
+
# Company
|
813
|
+
result = api_instance.official_companies20230301
|
814
|
+
p result
|
815
|
+
rescue OpenapiClient::ApiError => e
|
816
|
+
puts "Error when calling Class20230301Api->official_companies20230301: #{e}"
|
817
|
+
end
|
818
|
+
```
|
819
|
+
|
820
|
+
#### Using the official_companies20230301_with_http_info variant
|
821
|
+
|
822
|
+
This returns an Array which contains the response data, status code and headers.
|
823
|
+
|
824
|
+
> <Array(<Array<CompanyResponse>>, Integer, Hash)> official_companies20230301_with_http_info
|
825
|
+
|
826
|
+
```ruby
|
827
|
+
begin
|
828
|
+
# Company
|
829
|
+
data, status_code, headers = api_instance.official_companies20230301_with_http_info
|
830
|
+
p status_code # => 2xx
|
831
|
+
p headers # => { ... }
|
832
|
+
p data # => <Array<CompanyResponse>>
|
833
|
+
rescue OpenapiClient::ApiError => e
|
834
|
+
puts "Error when calling Class20230301Api->official_companies20230301_with_http_info: #{e}"
|
835
|
+
end
|
836
|
+
```
|
837
|
+
|
838
|
+
### Parameters
|
839
|
+
|
840
|
+
This endpoint does not need any parameter.
|
841
|
+
|
842
|
+
### Return type
|
843
|
+
|
844
|
+
[**Array<CompanyResponse>**](CompanyResponse.md)
|
845
|
+
|
846
|
+
### Authorization
|
847
|
+
|
848
|
+
[access-token](../README.md#access-token)
|
849
|
+
|
850
|
+
### HTTP request headers
|
851
|
+
|
852
|
+
- **Content-Type**: Not defined
|
853
|
+
- **Accept**: application/json
|
854
|
+
|
855
|
+
|
856
|
+
## official_create_employee20230301
|
857
|
+
|
858
|
+
> <EmployeeResponse> official_create_employee20230301(create_employee_request)
|
859
|
+
|
860
|
+
Create Employee
|
861
|
+
|
862
|
+
Creates a new Employee
|
863
|
+
|
864
|
+
### Examples
|
865
|
+
|
866
|
+
```ruby
|
867
|
+
require 'time'
|
868
|
+
require 'openapi_client'
|
869
|
+
# setup authorization
|
870
|
+
OpenapiClient.configure do |config|
|
871
|
+
# Configure API key authorization: access-token
|
872
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
873
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
874
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
875
|
+
end
|
876
|
+
|
877
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
878
|
+
create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest |
|
879
|
+
|
880
|
+
begin
|
881
|
+
# Create Employee
|
882
|
+
result = api_instance.official_create_employee20230301(create_employee_request)
|
883
|
+
p result
|
884
|
+
rescue OpenapiClient::ApiError => e
|
885
|
+
puts "Error when calling Class20230301Api->official_create_employee20230301: #{e}"
|
886
|
+
end
|
887
|
+
```
|
888
|
+
|
889
|
+
#### Using the official_create_employee20230301_with_http_info variant
|
890
|
+
|
891
|
+
This returns an Array which contains the response data, status code and headers.
|
892
|
+
|
893
|
+
> <Array(<EmployeeResponse>, Integer, Hash)> official_create_employee20230301_with_http_info(create_employee_request)
|
894
|
+
|
895
|
+
```ruby
|
896
|
+
begin
|
897
|
+
# Create Employee
|
898
|
+
data, status_code, headers = api_instance.official_create_employee20230301_with_http_info(create_employee_request)
|
899
|
+
p status_code # => 2xx
|
900
|
+
p headers # => { ... }
|
901
|
+
p data # => <EmployeeResponse>
|
902
|
+
rescue OpenapiClient::ApiError => e
|
903
|
+
puts "Error when calling Class20230301Api->official_create_employee20230301_with_http_info: #{e}"
|
904
|
+
end
|
905
|
+
```
|
906
|
+
|
907
|
+
### Parameters
|
908
|
+
|
909
|
+
| Name | Type | Description | Notes |
|
910
|
+
| ---- | ---- | ----------- | ----- |
|
911
|
+
| **create_employee_request** | [**CreateEmployeeRequest**](CreateEmployeeRequest.md) | | |
|
912
|
+
|
913
|
+
### Return type
|
914
|
+
|
915
|
+
[**EmployeeResponse**](EmployeeResponse.md)
|
916
|
+
|
917
|
+
### Authorization
|
918
|
+
|
919
|
+
[access-token](../README.md#access-token)
|
920
|
+
|
921
|
+
### HTTP request headers
|
922
|
+
|
923
|
+
- **Content-Type**: application/json
|
924
|
+
- **Accept**: application/json
|
925
|
+
|
926
|
+
|
927
|
+
## official_employees20230301
|
928
|
+
|
929
|
+
> <Array<EmployeeResponse>> official_employees20230301
|
930
|
+
|
931
|
+
Employees
|
932
|
+
|
933
|
+
List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
934
|
+
|
935
|
+
### Examples
|
936
|
+
|
937
|
+
```ruby
|
938
|
+
require 'time'
|
939
|
+
require 'openapi_client'
|
940
|
+
# setup authorization
|
941
|
+
OpenapiClient.configure do |config|
|
942
|
+
# Configure API key authorization: access-token
|
943
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
944
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
945
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
946
|
+
end
|
947
|
+
|
948
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
949
|
+
|
950
|
+
begin
|
951
|
+
# Employees
|
952
|
+
result = api_instance.official_employees20230301
|
953
|
+
p result
|
954
|
+
rescue OpenapiClient::ApiError => e
|
955
|
+
puts "Error when calling Class20230301Api->official_employees20230301: #{e}"
|
956
|
+
end
|
957
|
+
```
|
958
|
+
|
959
|
+
#### Using the official_employees20230301_with_http_info variant
|
960
|
+
|
961
|
+
This returns an Array which contains the response data, status code and headers.
|
962
|
+
|
963
|
+
> <Array(<Array<EmployeeResponse>>, Integer, Hash)> official_employees20230301_with_http_info
|
964
|
+
|
965
|
+
```ruby
|
966
|
+
begin
|
967
|
+
# Employees
|
968
|
+
data, status_code, headers = api_instance.official_employees20230301_with_http_info
|
969
|
+
p status_code # => 2xx
|
970
|
+
p headers # => { ... }
|
971
|
+
p data # => <Array<EmployeeResponse>>
|
972
|
+
rescue OpenapiClient::ApiError => e
|
973
|
+
puts "Error when calling Class20230301Api->official_employees20230301_with_http_info: #{e}"
|
974
|
+
end
|
975
|
+
```
|
976
|
+
|
977
|
+
### Parameters
|
978
|
+
|
979
|
+
This endpoint does not need any parameter.
|
980
|
+
|
981
|
+
### Return type
|
982
|
+
|
983
|
+
[**Array<EmployeeResponse>**](EmployeeResponse.md)
|
984
|
+
|
985
|
+
### Authorization
|
986
|
+
|
987
|
+
[access-token](../README.md#access-token)
|
988
|
+
|
989
|
+
### HTTP request headers
|
990
|
+
|
991
|
+
- **Content-Type**: Not defined
|
992
|
+
- **Accept**: application/json
|
993
|
+
|
994
|
+
|
995
|
+
## official_groups20230301
|
996
|
+
|
997
|
+
> <Array<GroupResponse>> official_groups20230301
|
998
|
+
|
999
|
+
Groups
|
1000
|
+
|
1001
|
+
The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
1002
|
+
|
1003
|
+
### Examples
|
1004
|
+
|
1005
|
+
```ruby
|
1006
|
+
require 'time'
|
1007
|
+
require 'openapi_client'
|
1008
|
+
# setup authorization
|
1009
|
+
OpenapiClient.configure do |config|
|
1010
|
+
# Configure API key authorization: access-token
|
1011
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
1012
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1013
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
1017
|
+
|
1018
|
+
begin
|
1019
|
+
# Groups
|
1020
|
+
result = api_instance.official_groups20230301
|
1021
|
+
p result
|
1022
|
+
rescue OpenapiClient::ApiError => e
|
1023
|
+
puts "Error when calling Class20230301Api->official_groups20230301: #{e}"
|
1024
|
+
end
|
1025
|
+
```
|
1026
|
+
|
1027
|
+
#### Using the official_groups20230301_with_http_info variant
|
1028
|
+
|
1029
|
+
This returns an Array which contains the response data, status code and headers.
|
1030
|
+
|
1031
|
+
> <Array(<Array<GroupResponse>>, Integer, Hash)> official_groups20230301_with_http_info
|
1032
|
+
|
1033
|
+
```ruby
|
1034
|
+
begin
|
1035
|
+
# Groups
|
1036
|
+
data, status_code, headers = api_instance.official_groups20230301_with_http_info
|
1037
|
+
p status_code # => 2xx
|
1038
|
+
p headers # => { ... }
|
1039
|
+
p data # => <Array<GroupResponse>>
|
1040
|
+
rescue OpenapiClient::ApiError => e
|
1041
|
+
puts "Error when calling Class20230301Api->official_groups20230301_with_http_info: #{e}"
|
1042
|
+
end
|
1043
|
+
```
|
1044
|
+
|
1045
|
+
### Parameters
|
1046
|
+
|
1047
|
+
This endpoint does not need any parameter.
|
1048
|
+
|
1049
|
+
### Return type
|
1050
|
+
|
1051
|
+
[**Array<GroupResponse>**](GroupResponse.md)
|
1052
|
+
|
1053
|
+
### Authorization
|
1054
|
+
|
1055
|
+
[access-token](../README.md#access-token)
|
1056
|
+
|
1057
|
+
### HTTP request headers
|
1058
|
+
|
1059
|
+
- **Content-Type**: Not defined
|
1060
|
+
- **Accept**: application/json
|
1061
|
+
|
1062
|
+
|
1063
|
+
## official_time_off_balances20230301
|
1064
|
+
|
1065
|
+
> <Array<TimeOffBalanceResponse>> official_time_off_balances20230301
|
1066
|
+
|
1067
|
+
Time off balances
|
1068
|
+
|
1069
|
+
Retrieve all time off balances.
|
1070
|
+
|
1071
|
+
### Examples
|
1072
|
+
|
1073
|
+
```ruby
|
1074
|
+
require 'time'
|
1075
|
+
require 'openapi_client'
|
1076
|
+
# setup authorization
|
1077
|
+
OpenapiClient.configure do |config|
|
1078
|
+
# Configure API key authorization: access-token
|
1079
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
1080
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1081
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
1085
|
+
|
1086
|
+
begin
|
1087
|
+
# Time off balances
|
1088
|
+
result = api_instance.official_time_off_balances20230301
|
1089
|
+
p result
|
1090
|
+
rescue OpenapiClient::ApiError => e
|
1091
|
+
puts "Error when calling Class20230301Api->official_time_off_balances20230301: #{e}"
|
1092
|
+
end
|
1093
|
+
```
|
1094
|
+
|
1095
|
+
#### Using the official_time_off_balances20230301_with_http_info variant
|
1096
|
+
|
1097
|
+
This returns an Array which contains the response data, status code and headers.
|
1098
|
+
|
1099
|
+
> <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> official_time_off_balances20230301_with_http_info
|
1100
|
+
|
1101
|
+
```ruby
|
1102
|
+
begin
|
1103
|
+
# Time off balances
|
1104
|
+
data, status_code, headers = api_instance.official_time_off_balances20230301_with_http_info
|
1105
|
+
p status_code # => 2xx
|
1106
|
+
p headers # => { ... }
|
1107
|
+
p data # => <Array<TimeOffBalanceResponse>>
|
1108
|
+
rescue OpenapiClient::ApiError => e
|
1109
|
+
puts "Error when calling Class20230301Api->official_time_off_balances20230301_with_http_info: #{e}"
|
1110
|
+
end
|
1111
|
+
```
|
1112
|
+
|
1113
|
+
### Parameters
|
1114
|
+
|
1115
|
+
This endpoint does not need any parameter.
|
1116
|
+
|
1117
|
+
### Return type
|
1118
|
+
|
1119
|
+
[**Array<TimeOffBalanceResponse>**](TimeOffBalanceResponse.md)
|
1120
|
+
|
1121
|
+
### Authorization
|
1122
|
+
|
1123
|
+
[access-token](../README.md#access-token)
|
1124
|
+
|
1125
|
+
### HTTP request headers
|
1126
|
+
|
1127
|
+
- **Content-Type**: Not defined
|
1128
|
+
- **Accept**: application/json
|
1129
|
+
|
1130
|
+
|
1131
|
+
## official_time_off_entries20230301
|
1132
|
+
|
1133
|
+
> <Array<TimeOffEntryResponse>> official_time_off_entries20230301
|
1134
|
+
|
1135
|
+
Time off entries
|
1136
|
+
|
1137
|
+
Retrieve time off / absence entries
|
1138
|
+
|
1139
|
+
### Examples
|
1140
|
+
|
1141
|
+
```ruby
|
1142
|
+
require 'time'
|
1143
|
+
require 'openapi_client'
|
1144
|
+
# setup authorization
|
1145
|
+
OpenapiClient.configure do |config|
|
1146
|
+
# Configure API key authorization: access-token
|
1147
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
1148
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1149
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
1153
|
+
|
1154
|
+
begin
|
1155
|
+
# Time off entries
|
1156
|
+
result = api_instance.official_time_off_entries20230301
|
1157
|
+
p result
|
1158
|
+
rescue OpenapiClient::ApiError => e
|
1159
|
+
puts "Error when calling Class20230301Api->official_time_off_entries20230301: #{e}"
|
1160
|
+
end
|
1161
|
+
```
|
1162
|
+
|
1163
|
+
#### Using the official_time_off_entries20230301_with_http_info variant
|
1164
|
+
|
1165
|
+
This returns an Array which contains the response data, status code and headers.
|
1166
|
+
|
1167
|
+
> <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> official_time_off_entries20230301_with_http_info
|
1168
|
+
|
1169
|
+
```ruby
|
1170
|
+
begin
|
1171
|
+
# Time off entries
|
1172
|
+
data, status_code, headers = api_instance.official_time_off_entries20230301_with_http_info
|
1173
|
+
p status_code # => 2xx
|
1174
|
+
p headers # => { ... }
|
1175
|
+
p data # => <Array<TimeOffEntryResponse>>
|
1176
|
+
rescue OpenapiClient::ApiError => e
|
1177
|
+
puts "Error when calling Class20230301Api->official_time_off_entries20230301_with_http_info: #{e}"
|
1178
|
+
end
|
1179
|
+
```
|
1180
|
+
|
1181
|
+
### Parameters
|
1182
|
+
|
1183
|
+
This endpoint does not need any parameter.
|
1184
|
+
|
1185
|
+
### Return type
|
1186
|
+
|
1187
|
+
[**Array<TimeOffEntryResponse>**](TimeOffEntryResponse.md)
|
1188
|
+
|
1189
|
+
### Authorization
|
1190
|
+
|
1191
|
+
[access-token](../README.md#access-token)
|
1192
|
+
|
1193
|
+
### HTTP request headers
|
1194
|
+
|
1195
|
+
- **Content-Type**: Not defined
|
1196
|
+
- **Accept**: application/json
|
1197
|
+
|
1198
|
+
|
1199
|
+
## official_timesheets20230301
|
1200
|
+
|
1201
|
+
> <Array<TimesheetResponse>> official_timesheets20230301
|
1202
|
+
|
1203
|
+
Timesheets
|
1204
|
+
|
1205
|
+
Retrieve Timesheets
|
1206
|
+
|
1207
|
+
### Examples
|
1208
|
+
|
1209
|
+
```ruby
|
1210
|
+
require 'time'
|
1211
|
+
require 'openapi_client'
|
1212
|
+
# setup authorization
|
1213
|
+
OpenapiClient.configure do |config|
|
1214
|
+
# Configure API key authorization: access-token
|
1215
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
1216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1217
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
1221
|
+
|
1222
|
+
begin
|
1223
|
+
# Timesheets
|
1224
|
+
result = api_instance.official_timesheets20230301
|
1225
|
+
p result
|
1226
|
+
rescue OpenapiClient::ApiError => e
|
1227
|
+
puts "Error when calling Class20230301Api->official_timesheets20230301: #{e}"
|
1228
|
+
end
|
1229
|
+
```
|
1230
|
+
|
1231
|
+
#### Using the official_timesheets20230301_with_http_info variant
|
1232
|
+
|
1233
|
+
This returns an Array which contains the response data, status code and headers.
|
1234
|
+
|
1235
|
+
> <Array(<Array<TimesheetResponse>>, Integer, Hash)> official_timesheets20230301_with_http_info
|
1236
|
+
|
1237
|
+
```ruby
|
1238
|
+
begin
|
1239
|
+
# Timesheets
|
1240
|
+
data, status_code, headers = api_instance.official_timesheets20230301_with_http_info
|
1241
|
+
p status_code # => 2xx
|
1242
|
+
p headers # => { ... }
|
1243
|
+
p data # => <Array<TimesheetResponse>>
|
1244
|
+
rescue OpenapiClient::ApiError => e
|
1245
|
+
puts "Error when calling Class20230301Api->official_timesheets20230301_with_http_info: #{e}"
|
1246
|
+
end
|
1247
|
+
```
|
1248
|
+
|
1249
|
+
### Parameters
|
1250
|
+
|
1251
|
+
This endpoint does not need any parameter.
|
1252
|
+
|
1253
|
+
### Return type
|
1254
|
+
|
1255
|
+
[**Array<TimesheetResponse>**](TimesheetResponse.md)
|
1256
|
+
|
1257
|
+
### Authorization
|
1258
|
+
|
1259
|
+
[access-token](../README.md#access-token)
|
1260
|
+
|
1261
|
+
### HTTP request headers
|
1262
|
+
|
1263
|
+
- **Content-Type**: Not defined
|
1264
|
+
- **Accept**: application/json
|
1265
|
+
|
1266
|
+
|
1267
|
+
## official_work_locations20230301
|
1268
|
+
|
1269
|
+
> <Array<LocationResponse>> official_work_locations20230301
|
1270
|
+
|
1271
|
+
Work locations
|
1272
|
+
|
1273
|
+
The Location object is used to represent an address that can be associated with an employee
|
1274
|
+
|
1275
|
+
### Examples
|
1276
|
+
|
1277
|
+
```ruby
|
1278
|
+
require 'time'
|
1279
|
+
require 'openapi_client'
|
1280
|
+
# setup authorization
|
1281
|
+
OpenapiClient.configure do |config|
|
1282
|
+
# Configure API key authorization: access-token
|
1283
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
1284
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1285
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
1286
|
+
end
|
1287
|
+
|
1288
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
1289
|
+
|
1290
|
+
begin
|
1291
|
+
# Work locations
|
1292
|
+
result = api_instance.official_work_locations20230301
|
1293
|
+
p result
|
1294
|
+
rescue OpenapiClient::ApiError => e
|
1295
|
+
puts "Error when calling Class20230301Api->official_work_locations20230301: #{e}"
|
1296
|
+
end
|
1297
|
+
```
|
1298
|
+
|
1299
|
+
#### Using the official_work_locations20230301_with_http_info variant
|
1300
|
+
|
1301
|
+
This returns an Array which contains the response data, status code and headers.
|
1302
|
+
|
1303
|
+
> <Array(<Array<LocationResponse>>, Integer, Hash)> official_work_locations20230301_with_http_info
|
1304
|
+
|
1305
|
+
```ruby
|
1306
|
+
begin
|
1307
|
+
# Work locations
|
1308
|
+
data, status_code, headers = api_instance.official_work_locations20230301_with_http_info
|
1309
|
+
p status_code # => 2xx
|
1310
|
+
p headers # => { ... }
|
1311
|
+
p data # => <Array<LocationResponse>>
|
1312
|
+
rescue OpenapiClient::ApiError => e
|
1313
|
+
puts "Error when calling Class20230301Api->official_work_locations20230301_with_http_info: #{e}"
|
1314
|
+
end
|
1315
|
+
```
|
1316
|
+
|
1317
|
+
### Parameters
|
1318
|
+
|
1319
|
+
This endpoint does not need any parameter.
|
1320
|
+
|
1321
|
+
### Return type
|
1322
|
+
|
1323
|
+
[**Array<LocationResponse>**](LocationResponse.md)
|
1324
|
+
|
1325
|
+
### Authorization
|
1326
|
+
|
1327
|
+
[access-token](../README.md#access-token)
|
1328
|
+
|
1329
|
+
### HTTP request headers
|
1330
|
+
|
1331
|
+
- **Content-Type**: Not defined
|
1332
|
+
- **Accept**: application/json
|
1333
|
+
|
1334
|
+
|
1335
|
+
## officialdentity20230301
|
1336
|
+
|
1337
|
+
> <IdentityResponse> officialdentity20230301
|
1338
|
+
|
1339
|
+
Identity
|
1340
|
+
|
1341
|
+
List information of the user for the respective account
|
1342
|
+
|
1343
|
+
### Examples
|
1344
|
+
|
1345
|
+
```ruby
|
1346
|
+
require 'time'
|
1347
|
+
require 'openapi_client'
|
1348
|
+
# setup authorization
|
1349
|
+
OpenapiClient.configure do |config|
|
1350
|
+
# Configure API key authorization: access-token
|
1351
|
+
config.api_key['access-token'] = 'YOUR API KEY'
|
1352
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1353
|
+
# config.api_key_prefix['access-token'] = 'Bearer'
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
api_instance = OpenapiClient::Class20230301Api.new
|
1357
|
+
|
1358
|
+
begin
|
1359
|
+
# Identity
|
1360
|
+
result = api_instance.officialdentity20230301
|
1361
|
+
p result
|
1362
|
+
rescue OpenapiClient::ApiError => e
|
1363
|
+
puts "Error when calling Class20230301Api->officialdentity20230301: #{e}"
|
1364
|
+
end
|
1365
|
+
```
|
1366
|
+
|
1367
|
+
#### Using the officialdentity20230301_with_http_info variant
|
1368
|
+
|
1369
|
+
This returns an Array which contains the response data, status code and headers.
|
1370
|
+
|
1371
|
+
> <Array(<IdentityResponse>, Integer, Hash)> officialdentity20230301_with_http_info
|
1372
|
+
|
1373
|
+
```ruby
|
1374
|
+
begin
|
1375
|
+
# Identity
|
1376
|
+
data, status_code, headers = api_instance.officialdentity20230301_with_http_info
|
1377
|
+
p status_code # => 2xx
|
1378
|
+
p headers # => { ... }
|
1379
|
+
p data # => <IdentityResponse>
|
1380
|
+
rescue OpenapiClient::ApiError => e
|
1381
|
+
puts "Error when calling Class20230301Api->officialdentity20230301_with_http_info: #{e}"
|
1382
|
+
end
|
1383
|
+
```
|
1384
|
+
|
1385
|
+
### Parameters
|
1386
|
+
|
1387
|
+
This endpoint does not need any parameter.
|
1388
|
+
|
1389
|
+
### Return type
|
1390
|
+
|
1391
|
+
[**IdentityResponse**](IdentityResponse.md)
|
1392
|
+
|
1393
|
+
### Authorization
|
1394
|
+
|
1395
|
+
[access-token](../README.md#access-token)
|
1396
|
+
|
1397
|
+
### HTTP request headers
|
1398
|
+
|
1399
|
+
- **Content-Type**: Not defined
|
1400
|
+
- **Accept**: application/json
|
1401
|
+
|