affixapi 1.1.46 → 1.1.48
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +16 -36
- data/docs/Class20230301Api.md +0 -696
- data/docs/{XHRApi.md → XHRVerticallyIntegratedApi.md} +41 -113
- data/lib/openapi_client/api/class20230301_api.rb +1 -587
- data/lib/openapi_client/api/core_api.rb +1 -1
- data/lib/openapi_client/api/management_api.rb +1 -1
- data/lib/openapi_client/api/{xhr_api.rb → xhr_vertically_integrated_api.rb} +35 -100
- data/lib/openapi_client/api_client.rb +1 -1
- data/lib/openapi_client/api_error.rb +1 -1
- data/lib/openapi_client/configuration.rb +1 -1
- data/lib/openapi_client/models/address_no_non_null_request.rb +1 -1
- data/lib/openapi_client/models/address_response.rb +1 -1
- data/lib/openapi_client/models/client_request.rb +1 -1
- data/lib/openapi_client/models/client_response.rb +1 -1
- data/lib/openapi_client/models/company_response.rb +1 -1
- data/lib/openapi_client/models/create_employee_request.rb +1 -1
- data/lib/openapi_client/models/create_employee_request_bank_account.rb +1 -1
- data/lib/openapi_client/models/create_employee_request_manager.rb +1 -1
- data/lib/openapi_client/models/currency_request.rb +1 -1
- data/lib/openapi_client/models/currency_response.rb +1 -1
- data/lib/openapi_client/models/disconnect_response.rb +1 -1
- data/lib/openapi_client/models/employee_response.rb +1 -1
- data/lib/openapi_client/models/employment_no_null_enum_request.rb +1 -1
- data/lib/openapi_client/models/employment_response.rb +1 -1
- data/lib/openapi_client/models/group_no_null_enum_request.rb +1 -1
- data/lib/openapi_client/models/group_response.rb +1 -1
- data/lib/openapi_client/models/id_and_message_response.rb +1 -1
- data/lib/openapi_client/models/identity_response.rb +1 -1
- data/lib/openapi_client/models/inline_response400.rb +1 -1
- data/lib/openapi_client/models/inline_response401.rb +1 -1
- data/lib/openapi_client/models/inline_response409.rb +1 -1
- data/lib/openapi_client/models/introspect_response.rb +1 -1
- data/lib/openapi_client/models/location_no_non_null_request.rb +1 -1
- data/lib/openapi_client/models/location_response.rb +1 -1
- data/lib/openapi_client/models/message_response.rb +1 -1
- data/lib/openapi_client/models/mode_request.rb +1 -1
- data/lib/openapi_client/models/mode_response.rb +1 -1
- data/lib/openapi_client/models/payrun_response.rb +1 -1
- data/lib/openapi_client/models/payslip_response.rb +1 -1
- data/lib/openapi_client/models/payslip_response_contributions.rb +1 -1
- data/lib/openapi_client/models/payslip_response_deductions.rb +1 -1
- data/lib/openapi_client/models/payslip_response_earnings.rb +1 -1
- data/lib/openapi_client/models/payslip_response_taxes.rb +1 -1
- data/lib/openapi_client/models/provider_request.rb +1 -1
- data/lib/openapi_client/models/provider_response.rb +1 -1
- data/lib/openapi_client/models/scopes_request.rb +1 -1
- data/lib/openapi_client/models/scopes_response.rb +1 -1
- data/lib/openapi_client/models/time_off_balance_response.rb +1 -1
- data/lib/openapi_client/models/time_off_entry_response.rb +1 -1
- data/lib/openapi_client/models/timesheet_response.rb +1 -1
- data/lib/openapi_client/models/token_request.rb +1 -1
- data/lib/openapi_client/models/token_response.rb +1 -1
- data/lib/openapi_client/version.rb +2 -2
- data/lib/openapi_client.rb +2 -3
- data/spec/api/class20230301_api_spec.rb +1 -113
- data/spec/api/core_api_spec.rb +1 -1
- data/spec/api/management_api_spec.rb +1 -1
- data/spec/api/xhr_vertically_integrated_api_spec.rb +148 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/address_no_non_null_request_spec.rb +1 -1
- data/spec/models/address_response_spec.rb +1 -1
- data/spec/models/client_request_spec.rb +1 -1
- data/spec/models/client_response_spec.rb +1 -1
- data/spec/models/company_response_spec.rb +1 -1
- data/spec/models/create_employee_request_bank_account_spec.rb +1 -1
- data/spec/models/create_employee_request_manager_spec.rb +1 -1
- data/spec/models/create_employee_request_spec.rb +1 -1
- data/spec/models/currency_request_spec.rb +1 -1
- data/spec/models/currency_response_spec.rb +1 -1
- data/spec/models/disconnect_response_spec.rb +1 -1
- data/spec/models/employee_response_spec.rb +1 -1
- data/spec/models/employment_no_null_enum_request_spec.rb +1 -1
- data/spec/models/employment_response_spec.rb +1 -1
- data/spec/models/group_no_null_enum_request_spec.rb +1 -1
- data/spec/models/group_response_spec.rb +1 -1
- data/spec/models/id_and_message_response_spec.rb +1 -1
- data/spec/models/identity_response_spec.rb +1 -1
- data/spec/models/inline_response400_spec.rb +1 -1
- data/spec/models/inline_response401_spec.rb +1 -1
- data/spec/models/inline_response409_spec.rb +1 -1
- data/spec/models/introspect_response_spec.rb +1 -1
- data/spec/models/location_no_non_null_request_spec.rb +1 -1
- data/spec/models/location_response_spec.rb +1 -1
- data/spec/models/message_response_spec.rb +1 -1
- data/spec/models/mode_request_spec.rb +1 -1
- data/spec/models/mode_response_spec.rb +1 -1
- data/spec/models/payrun_response_spec.rb +1 -1
- data/spec/models/payslip_response_contributions_spec.rb +1 -1
- data/spec/models/payslip_response_deductions_spec.rb +1 -1
- data/spec/models/payslip_response_earnings_spec.rb +1 -1
- data/spec/models/payslip_response_spec.rb +1 -1
- data/spec/models/payslip_response_taxes_spec.rb +1 -1
- data/spec/models/provider_request_spec.rb +1 -1
- data/spec/models/provider_response_spec.rb +1 -1
- data/spec/models/scopes_request_spec.rb +1 -1
- data/spec/models/scopes_response_spec.rb +1 -1
- data/spec/models/time_off_balance_response_spec.rb +1 -1
- data/spec/models/time_off_entry_response_spec.rb +1 -1
- data/spec/models/timesheet_response_spec.rb +1 -1
- data/spec/models/token_request_spec.rb +1 -1
- data/spec/models/token_response_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +6 -10
- data/docs/OfficialApi.md +0 -631
- data/lib/openapi_client/api/official_api.rb +0 -543
- data/spec/api/official_api_spec.rb +0 -135
- data/spec/api/xhr_api_spec.rb +0 -160
data/docs/Class20230301Api.md
CHANGED
@@ -4,17 +4,7 @@ All URIs are relative to *https://api.affixapi.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**official_companies20230301**](Class20230301Api.md#official_companies20230301) | **GET** /2023-03-01/official/company | Company |
|
8
|
-
| [**official_create_employee20230301**](Class20230301Api.md#official_create_employee20230301) | **POST** /2023-03-01/official/employee | Create Employee |
|
9
|
-
| [**official_employees20230301**](Class20230301Api.md#official_employees20230301) | **GET** /2023-03-01/official/employees | Employees |
|
10
|
-
| [**official_groups20230301**](Class20230301Api.md#official_groups20230301) | **GET** /2023-03-01/official/groups | Groups |
|
11
|
-
| [**official_time_off_balances20230301**](Class20230301Api.md#official_time_off_balances20230301) | **GET** /2023-03-01/official/time-off-balances | Time off balances |
|
12
|
-
| [**official_time_off_entries20230301**](Class20230301Api.md#official_time_off_entries20230301) | **GET** /2023-03-01/official/time-off-entries | Time off entries |
|
13
|
-
| [**official_timesheets20230301**](Class20230301Api.md#official_timesheets20230301) | **GET** /2023-03-01/official/timesheets | Timesheets |
|
14
|
-
| [**official_work_locations20230301**](Class20230301Api.md#official_work_locations20230301) | **GET** /2023-03-01/official/work-locations | Work locations |
|
15
|
-
| [**officialdentity20230301**](Class20230301Api.md#officialdentity20230301) | **GET** /2023-03-01/official/identity | Identity |
|
16
7
|
| [**xhr_companies20230301**](Class20230301Api.md#xhr_companies20230301) | **GET** /2023-03-01/xhr/company | Company |
|
17
|
-
| [**xhr_create_employee20230301**](Class20230301Api.md#xhr_create_employee20230301) | **POST** /2023-03-01/xhr/employee | Create employee |
|
18
8
|
| [**xhr_employees20230301**](Class20230301Api.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees |
|
19
9
|
| [**xhr_groups20230301**](Class20230301Api.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups |
|
20
10
|
| [**xhr_identity20230301**](Class20230301Api.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity |
|
@@ -26,621 +16,6 @@ All URIs are relative to *https://api.affixapi.com*
|
|
26
16
|
| [**xhr_work_locations20230301**](Class20230301Api.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations |
|
27
17
|
|
28
18
|
|
29
|
-
## official_companies20230301
|
30
|
-
|
31
|
-
> <Array<CompanyResponse>> official_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.official_companies20230301
|
55
|
-
p result
|
56
|
-
rescue OpenapiClient::ApiError => e
|
57
|
-
puts "Error when calling Class20230301Api->official_companies20230301: #{e}"
|
58
|
-
end
|
59
|
-
```
|
60
|
-
|
61
|
-
#### Using the official_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)> official_companies20230301_with_http_info
|
66
|
-
|
67
|
-
```ruby
|
68
|
-
begin
|
69
|
-
# Company
|
70
|
-
data, status_code, headers = api_instance.official_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->official_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
|
-
## official_create_employee20230301
|
98
|
-
|
99
|
-
> <EmployeeResponse> official_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.official_create_employee20230301(create_employee_request)
|
124
|
-
p result
|
125
|
-
rescue OpenapiClient::ApiError => e
|
126
|
-
puts "Error when calling Class20230301Api->official_create_employee20230301: #{e}"
|
127
|
-
end
|
128
|
-
```
|
129
|
-
|
130
|
-
#### Using the official_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)> official_create_employee20230301_with_http_info(create_employee_request)
|
135
|
-
|
136
|
-
```ruby
|
137
|
-
begin
|
138
|
-
# Create Employee
|
139
|
-
data, status_code, headers = api_instance.official_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->official_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
|
-
## official_employees20230301
|
169
|
-
|
170
|
-
> <Array<EmployeeResponse>> official_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.official_employees20230301
|
194
|
-
p result
|
195
|
-
rescue OpenapiClient::ApiError => e
|
196
|
-
puts "Error when calling Class20230301Api->official_employees20230301: #{e}"
|
197
|
-
end
|
198
|
-
```
|
199
|
-
|
200
|
-
#### Using the official_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)> official_employees20230301_with_http_info
|
205
|
-
|
206
|
-
```ruby
|
207
|
-
begin
|
208
|
-
# Employees
|
209
|
-
data, status_code, headers = api_instance.official_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->official_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
|
-
## official_groups20230301
|
237
|
-
|
238
|
-
> <Array<GroupResponse>> official_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.official_groups20230301
|
262
|
-
p result
|
263
|
-
rescue OpenapiClient::ApiError => e
|
264
|
-
puts "Error when calling Class20230301Api->official_groups20230301: #{e}"
|
265
|
-
end
|
266
|
-
```
|
267
|
-
|
268
|
-
#### Using the official_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)> official_groups20230301_with_http_info
|
273
|
-
|
274
|
-
```ruby
|
275
|
-
begin
|
276
|
-
# Groups
|
277
|
-
data, status_code, headers = api_instance.official_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->official_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
|
-
## official_time_off_balances20230301
|
305
|
-
|
306
|
-
> <Array<TimeOffBalanceResponse>> official_time_off_balances20230301
|
307
|
-
|
308
|
-
Time off balances
|
309
|
-
|
310
|
-
Retrieve all time off balances.
|
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
|
-
# Time off balances
|
329
|
-
result = api_instance.official_time_off_balances20230301
|
330
|
-
p result
|
331
|
-
rescue OpenapiClient::ApiError => e
|
332
|
-
puts "Error when calling Class20230301Api->official_time_off_balances20230301: #{e}"
|
333
|
-
end
|
334
|
-
```
|
335
|
-
|
336
|
-
#### Using the official_time_off_balances20230301_with_http_info variant
|
337
|
-
|
338
|
-
This returns an Array which contains the response data, status code and headers.
|
339
|
-
|
340
|
-
> <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> official_time_off_balances20230301_with_http_info
|
341
|
-
|
342
|
-
```ruby
|
343
|
-
begin
|
344
|
-
# Time off balances
|
345
|
-
data, status_code, headers = api_instance.official_time_off_balances20230301_with_http_info
|
346
|
-
p status_code # => 2xx
|
347
|
-
p headers # => { ... }
|
348
|
-
p data # => <Array<TimeOffBalanceResponse>>
|
349
|
-
rescue OpenapiClient::ApiError => e
|
350
|
-
puts "Error when calling Class20230301Api->official_time_off_balances20230301_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
|
-
[**Array<TimeOffBalanceResponse>**](TimeOffBalanceResponse.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
|
-
## official_time_off_entries20230301
|
373
|
-
|
374
|
-
> <Array<TimeOffEntryResponse>> official_time_off_entries20230301
|
375
|
-
|
376
|
-
Time off entries
|
377
|
-
|
378
|
-
Retrieve time off / absence entries
|
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
|
-
|
395
|
-
begin
|
396
|
-
# Time off entries
|
397
|
-
result = api_instance.official_time_off_entries20230301
|
398
|
-
p result
|
399
|
-
rescue OpenapiClient::ApiError => e
|
400
|
-
puts "Error when calling Class20230301Api->official_time_off_entries20230301: #{e}"
|
401
|
-
end
|
402
|
-
```
|
403
|
-
|
404
|
-
#### Using the official_time_off_entries20230301_with_http_info variant
|
405
|
-
|
406
|
-
This returns an Array which contains the response data, status code and headers.
|
407
|
-
|
408
|
-
> <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> official_time_off_entries20230301_with_http_info
|
409
|
-
|
410
|
-
```ruby
|
411
|
-
begin
|
412
|
-
# Time off entries
|
413
|
-
data, status_code, headers = api_instance.official_time_off_entries20230301_with_http_info
|
414
|
-
p status_code # => 2xx
|
415
|
-
p headers # => { ... }
|
416
|
-
p data # => <Array<TimeOffEntryResponse>>
|
417
|
-
rescue OpenapiClient::ApiError => e
|
418
|
-
puts "Error when calling Class20230301Api->official_time_off_entries20230301_with_http_info: #{e}"
|
419
|
-
end
|
420
|
-
```
|
421
|
-
|
422
|
-
### Parameters
|
423
|
-
|
424
|
-
This endpoint does not need any parameter.
|
425
|
-
|
426
|
-
### Return type
|
427
|
-
|
428
|
-
[**Array<TimeOffEntryResponse>**](TimeOffEntryResponse.md)
|
429
|
-
|
430
|
-
### Authorization
|
431
|
-
|
432
|
-
[access-token](../README.md#access-token)
|
433
|
-
|
434
|
-
### HTTP request headers
|
435
|
-
|
436
|
-
- **Content-Type**: Not defined
|
437
|
-
- **Accept**: application/json
|
438
|
-
|
439
|
-
|
440
|
-
## official_timesheets20230301
|
441
|
-
|
442
|
-
> <Array<TimesheetResponse>> official_timesheets20230301
|
443
|
-
|
444
|
-
Timesheets
|
445
|
-
|
446
|
-
Retrieve Timesheets
|
447
|
-
|
448
|
-
### Examples
|
449
|
-
|
450
|
-
```ruby
|
451
|
-
require 'time'
|
452
|
-
require 'openapi_client'
|
453
|
-
# setup authorization
|
454
|
-
OpenapiClient.configure do |config|
|
455
|
-
# Configure API key authorization: access-token
|
456
|
-
config.api_key['access-token'] = 'YOUR API KEY'
|
457
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
458
|
-
# config.api_key_prefix['access-token'] = 'Bearer'
|
459
|
-
end
|
460
|
-
|
461
|
-
api_instance = OpenapiClient::Class20230301Api.new
|
462
|
-
|
463
|
-
begin
|
464
|
-
# Timesheets
|
465
|
-
result = api_instance.official_timesheets20230301
|
466
|
-
p result
|
467
|
-
rescue OpenapiClient::ApiError => e
|
468
|
-
puts "Error when calling Class20230301Api->official_timesheets20230301: #{e}"
|
469
|
-
end
|
470
|
-
```
|
471
|
-
|
472
|
-
#### Using the official_timesheets20230301_with_http_info variant
|
473
|
-
|
474
|
-
This returns an Array which contains the response data, status code and headers.
|
475
|
-
|
476
|
-
> <Array(<Array<TimesheetResponse>>, Integer, Hash)> official_timesheets20230301_with_http_info
|
477
|
-
|
478
|
-
```ruby
|
479
|
-
begin
|
480
|
-
# Timesheets
|
481
|
-
data, status_code, headers = api_instance.official_timesheets20230301_with_http_info
|
482
|
-
p status_code # => 2xx
|
483
|
-
p headers # => { ... }
|
484
|
-
p data # => <Array<TimesheetResponse>>
|
485
|
-
rescue OpenapiClient::ApiError => e
|
486
|
-
puts "Error when calling Class20230301Api->official_timesheets20230301_with_http_info: #{e}"
|
487
|
-
end
|
488
|
-
```
|
489
|
-
|
490
|
-
### Parameters
|
491
|
-
|
492
|
-
This endpoint does not need any parameter.
|
493
|
-
|
494
|
-
### Return type
|
495
|
-
|
496
|
-
[**Array<TimesheetResponse>**](TimesheetResponse.md)
|
497
|
-
|
498
|
-
### Authorization
|
499
|
-
|
500
|
-
[access-token](../README.md#access-token)
|
501
|
-
|
502
|
-
### HTTP request headers
|
503
|
-
|
504
|
-
- **Content-Type**: Not defined
|
505
|
-
- **Accept**: application/json
|
506
|
-
|
507
|
-
|
508
|
-
## official_work_locations20230301
|
509
|
-
|
510
|
-
> <Array<LocationResponse>> official_work_locations20230301
|
511
|
-
|
512
|
-
Work locations
|
513
|
-
|
514
|
-
The Location object is used to represent an address that can be associated with an employee
|
515
|
-
|
516
|
-
### Examples
|
517
|
-
|
518
|
-
```ruby
|
519
|
-
require 'time'
|
520
|
-
require 'openapi_client'
|
521
|
-
# setup authorization
|
522
|
-
OpenapiClient.configure do |config|
|
523
|
-
# Configure API key authorization: access-token
|
524
|
-
config.api_key['access-token'] = 'YOUR API KEY'
|
525
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
526
|
-
# config.api_key_prefix['access-token'] = 'Bearer'
|
527
|
-
end
|
528
|
-
|
529
|
-
api_instance = OpenapiClient::Class20230301Api.new
|
530
|
-
|
531
|
-
begin
|
532
|
-
# Work locations
|
533
|
-
result = api_instance.official_work_locations20230301
|
534
|
-
p result
|
535
|
-
rescue OpenapiClient::ApiError => e
|
536
|
-
puts "Error when calling Class20230301Api->official_work_locations20230301: #{e}"
|
537
|
-
end
|
538
|
-
```
|
539
|
-
|
540
|
-
#### Using the official_work_locations20230301_with_http_info variant
|
541
|
-
|
542
|
-
This returns an Array which contains the response data, status code and headers.
|
543
|
-
|
544
|
-
> <Array(<Array<LocationResponse>>, Integer, Hash)> official_work_locations20230301_with_http_info
|
545
|
-
|
546
|
-
```ruby
|
547
|
-
begin
|
548
|
-
# Work locations
|
549
|
-
data, status_code, headers = api_instance.official_work_locations20230301_with_http_info
|
550
|
-
p status_code # => 2xx
|
551
|
-
p headers # => { ... }
|
552
|
-
p data # => <Array<LocationResponse>>
|
553
|
-
rescue OpenapiClient::ApiError => e
|
554
|
-
puts "Error when calling Class20230301Api->official_work_locations20230301_with_http_info: #{e}"
|
555
|
-
end
|
556
|
-
```
|
557
|
-
|
558
|
-
### Parameters
|
559
|
-
|
560
|
-
This endpoint does not need any parameter.
|
561
|
-
|
562
|
-
### Return type
|
563
|
-
|
564
|
-
[**Array<LocationResponse>**](LocationResponse.md)
|
565
|
-
|
566
|
-
### Authorization
|
567
|
-
|
568
|
-
[access-token](../README.md#access-token)
|
569
|
-
|
570
|
-
### HTTP request headers
|
571
|
-
|
572
|
-
- **Content-Type**: Not defined
|
573
|
-
- **Accept**: application/json
|
574
|
-
|
575
|
-
|
576
|
-
## officialdentity20230301
|
577
|
-
|
578
|
-
> <IdentityResponse> officialdentity20230301
|
579
|
-
|
580
|
-
Identity
|
581
|
-
|
582
|
-
List information of the user for the respective account
|
583
|
-
|
584
|
-
### Examples
|
585
|
-
|
586
|
-
```ruby
|
587
|
-
require 'time'
|
588
|
-
require 'openapi_client'
|
589
|
-
# setup authorization
|
590
|
-
OpenapiClient.configure do |config|
|
591
|
-
# Configure API key authorization: access-token
|
592
|
-
config.api_key['access-token'] = 'YOUR API KEY'
|
593
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
594
|
-
# config.api_key_prefix['access-token'] = 'Bearer'
|
595
|
-
end
|
596
|
-
|
597
|
-
api_instance = OpenapiClient::Class20230301Api.new
|
598
|
-
|
599
|
-
begin
|
600
|
-
# Identity
|
601
|
-
result = api_instance.officialdentity20230301
|
602
|
-
p result
|
603
|
-
rescue OpenapiClient::ApiError => e
|
604
|
-
puts "Error when calling Class20230301Api->officialdentity20230301: #{e}"
|
605
|
-
end
|
606
|
-
```
|
607
|
-
|
608
|
-
#### Using the officialdentity20230301_with_http_info variant
|
609
|
-
|
610
|
-
This returns an Array which contains the response data, status code and headers.
|
611
|
-
|
612
|
-
> <Array(<IdentityResponse>, Integer, Hash)> officialdentity20230301_with_http_info
|
613
|
-
|
614
|
-
```ruby
|
615
|
-
begin
|
616
|
-
# Identity
|
617
|
-
data, status_code, headers = api_instance.officialdentity20230301_with_http_info
|
618
|
-
p status_code # => 2xx
|
619
|
-
p headers # => { ... }
|
620
|
-
p data # => <IdentityResponse>
|
621
|
-
rescue OpenapiClient::ApiError => e
|
622
|
-
puts "Error when calling Class20230301Api->officialdentity20230301_with_http_info: #{e}"
|
623
|
-
end
|
624
|
-
```
|
625
|
-
|
626
|
-
### Parameters
|
627
|
-
|
628
|
-
This endpoint does not need any parameter.
|
629
|
-
|
630
|
-
### Return type
|
631
|
-
|
632
|
-
[**IdentityResponse**](IdentityResponse.md)
|
633
|
-
|
634
|
-
### Authorization
|
635
|
-
|
636
|
-
[access-token](../README.md#access-token)
|
637
|
-
|
638
|
-
### HTTP request headers
|
639
|
-
|
640
|
-
- **Content-Type**: Not defined
|
641
|
-
- **Accept**: application/json
|
642
|
-
|
643
|
-
|
644
19
|
## xhr_companies20230301
|
645
20
|
|
646
21
|
> <Array<CompanyResponse>> xhr_companies20230301
|
@@ -709,77 +84,6 @@ This endpoint does not need any parameter.
|
|
709
84
|
- **Accept**: application/json
|
710
85
|
|
711
86
|
|
712
|
-
## xhr_create_employee20230301
|
713
|
-
|
714
|
-
> <EmployeeResponse> xhr_create_employee20230301(create_employee_request)
|
715
|
-
|
716
|
-
Create employee
|
717
|
-
|
718
|
-
Creates a new Employee
|
719
|
-
|
720
|
-
### Examples
|
721
|
-
|
722
|
-
```ruby
|
723
|
-
require 'time'
|
724
|
-
require 'openapi_client'
|
725
|
-
# setup authorization
|
726
|
-
OpenapiClient.configure do |config|
|
727
|
-
# Configure API key authorization: access-token
|
728
|
-
config.api_key['access-token'] = 'YOUR API KEY'
|
729
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
730
|
-
# config.api_key_prefix['access-token'] = 'Bearer'
|
731
|
-
end
|
732
|
-
|
733
|
-
api_instance = OpenapiClient::Class20230301Api.new
|
734
|
-
create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest |
|
735
|
-
|
736
|
-
begin
|
737
|
-
# Create employee
|
738
|
-
result = api_instance.xhr_create_employee20230301(create_employee_request)
|
739
|
-
p result
|
740
|
-
rescue OpenapiClient::ApiError => e
|
741
|
-
puts "Error when calling Class20230301Api->xhr_create_employee20230301: #{e}"
|
742
|
-
end
|
743
|
-
```
|
744
|
-
|
745
|
-
#### Using the xhr_create_employee20230301_with_http_info variant
|
746
|
-
|
747
|
-
This returns an Array which contains the response data, status code and headers.
|
748
|
-
|
749
|
-
> <Array(<EmployeeResponse>, Integer, Hash)> xhr_create_employee20230301_with_http_info(create_employee_request)
|
750
|
-
|
751
|
-
```ruby
|
752
|
-
begin
|
753
|
-
# Create employee
|
754
|
-
data, status_code, headers = api_instance.xhr_create_employee20230301_with_http_info(create_employee_request)
|
755
|
-
p status_code # => 2xx
|
756
|
-
p headers # => { ... }
|
757
|
-
p data # => <EmployeeResponse>
|
758
|
-
rescue OpenapiClient::ApiError => e
|
759
|
-
puts "Error when calling Class20230301Api->xhr_create_employee20230301_with_http_info: #{e}"
|
760
|
-
end
|
761
|
-
```
|
762
|
-
|
763
|
-
### Parameters
|
764
|
-
|
765
|
-
| Name | Type | Description | Notes |
|
766
|
-
| ---- | ---- | ----------- | ----- |
|
767
|
-
| **create_employee_request** | [**CreateEmployeeRequest**](CreateEmployeeRequest.md) | | |
|
768
|
-
|
769
|
-
### Return type
|
770
|
-
|
771
|
-
[**EmployeeResponse**](EmployeeResponse.md)
|
772
|
-
|
773
|
-
### Authorization
|
774
|
-
|
775
|
-
[access-token](../README.md#access-token)
|
776
|
-
|
777
|
-
### HTTP request headers
|
778
|
-
|
779
|
-
- **Content-Type**: application/json
|
780
|
-
- **Accept**: application/json
|
781
|
-
|
782
|
-
|
783
87
|
## xhr_employees20230301
|
784
88
|
|
785
89
|
> <Array<EmployeeResponse>> xhr_employees20230301
|