affixapi 1.1.45 → 1.1.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +27 -27
- data/docs/Class20230301Api.md +289 -289
- data/docs/CoreApi.md +1 -1
- data/docs/{DeveloperApi.md → XHRApi.md} +111 -111
- data/lib/openapi_client/api/class20230301_api.rb +288 -288
- data/lib/openapi_client/api/core_api.rb +3 -3
- data/lib/openapi_client/api/management_api.rb +1 -1
- data/lib/openapi_client/api/official_api.rb +1 -1
- data/lib/openapi_client/api/{developer_api.rb → xhr_api.rb} +83 -83
- 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 +2 -2
- data/lib/openapi_client/models/mode_response.rb +2 -2
- 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 +12 -12
- data/lib/openapi_client/models/scopes_response.rb +12 -12
- 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 -2
- data/spec/api/class20230301_api_spec.rb +82 -82
- data/spec/api/core_api_spec.rb +2 -2
- data/spec/api/management_api_spec.rb +1 -1
- data/spec/api/official_api_spec.rb +1 -1
- data/spec/api/xhr_api_spec.rb +160 -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 -6
- data/spec/api/developer_api_spec.rb +0 -160
data/docs/Class20230301Api.md
CHANGED
|
@@ -4,17 +4,6 @@ All URIs are relative to *https://api.affixapi.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
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
7
|
| [**official_companies20230301**](Class20230301Api.md#official_companies20230301) | **GET** /2023-03-01/official/company | Company |
|
|
19
8
|
| [**official_create_employee20230301**](Class20230301Api.md#official_create_employee20230301) | **POST** /2023-03-01/official/employee | Create Employee |
|
|
20
9
|
| [**official_employees20230301**](Class20230301Api.md#official_employees20230301) | **GET** /2023-03-01/official/employees | Employees |
|
|
@@ -24,11 +13,22 @@ All URIs are relative to *https://api.affixapi.com*
|
|
|
24
13
|
| [**official_timesheets20230301**](Class20230301Api.md#official_timesheets20230301) | **GET** /2023-03-01/official/timesheets | Timesheets |
|
|
25
14
|
| [**official_work_locations20230301**](Class20230301Api.md#official_work_locations20230301) | **GET** /2023-03-01/official/work-locations | Work locations |
|
|
26
15
|
| [**officialdentity20230301**](Class20230301Api.md#officialdentity20230301) | **GET** /2023-03-01/official/identity | Identity |
|
|
16
|
+
| [**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
|
+
| [**xhr_employees20230301**](Class20230301Api.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees |
|
|
19
|
+
| [**xhr_groups20230301**](Class20230301Api.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups |
|
|
20
|
+
| [**xhr_identity20230301**](Class20230301Api.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity |
|
|
21
|
+
| [**xhr_payruns20230301**](Class20230301Api.md#xhr_payruns20230301) | **GET** /2023-03-01/xhr/payruns | Payruns |
|
|
22
|
+
| [**xhr_payslips20230301**](Class20230301Api.md#xhr_payslips20230301) | **GET** /2023-03-01/xhr/payruns/{payrun_id} | Payslips |
|
|
23
|
+
| [**xhr_time_off_balances20230301**](Class20230301Api.md#xhr_time_off_balances20230301) | **GET** /2023-03-01/xhr/time-off-balances | Time off balances |
|
|
24
|
+
| [**xhr_time_off_entries20230301**](Class20230301Api.md#xhr_time_off_entries20230301) | **GET** /2023-03-01/xhr/time-off-entries | Time off entries |
|
|
25
|
+
| [**xhr_timesheets20230301**](Class20230301Api.md#xhr_timesheets20230301) | **GET** /2023-03-01/xhr/timesheets | Timesheets |
|
|
26
|
+
| [**xhr_work_locations20230301**](Class20230301Api.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations |
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## official_companies20230301
|
|
30
30
|
|
|
31
|
-
> <Array<CompanyResponse>>
|
|
31
|
+
> <Array<CompanyResponse>> official_companies20230301
|
|
32
32
|
|
|
33
33
|
Company
|
|
34
34
|
|
|
@@ -51,28 +51,28 @@ api_instance = OpenapiClient::Class20230301Api.new
|
|
|
51
51
|
|
|
52
52
|
begin
|
|
53
53
|
# Company
|
|
54
|
-
result = api_instance.
|
|
54
|
+
result = api_instance.official_companies20230301
|
|
55
55
|
p result
|
|
56
56
|
rescue OpenapiClient::ApiError => e
|
|
57
|
-
puts "Error when calling Class20230301Api->
|
|
57
|
+
puts "Error when calling Class20230301Api->official_companies20230301: #{e}"
|
|
58
58
|
end
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
-
#### Using the
|
|
61
|
+
#### Using the official_companies20230301_with_http_info variant
|
|
62
62
|
|
|
63
63
|
This returns an Array which contains the response data, status code and headers.
|
|
64
64
|
|
|
65
|
-
> <Array(<Array<CompanyResponse>>, Integer, Hash)>
|
|
65
|
+
> <Array(<Array<CompanyResponse>>, Integer, Hash)> official_companies20230301_with_http_info
|
|
66
66
|
|
|
67
67
|
```ruby
|
|
68
68
|
begin
|
|
69
69
|
# Company
|
|
70
|
-
data, status_code, headers = api_instance.
|
|
70
|
+
data, status_code, headers = api_instance.official_companies20230301_with_http_info
|
|
71
71
|
p status_code # => 2xx
|
|
72
72
|
p headers # => { ... }
|
|
73
73
|
p data # => <Array<CompanyResponse>>
|
|
74
74
|
rescue OpenapiClient::ApiError => e
|
|
75
|
-
puts "Error when calling Class20230301Api->
|
|
75
|
+
puts "Error when calling Class20230301Api->official_companies20230301_with_http_info: #{e}"
|
|
76
76
|
end
|
|
77
77
|
```
|
|
78
78
|
|
|
@@ -94,11 +94,11 @@ This endpoint does not need any parameter.
|
|
|
94
94
|
- **Accept**: application/json
|
|
95
95
|
|
|
96
96
|
|
|
97
|
-
##
|
|
97
|
+
## official_create_employee20230301
|
|
98
98
|
|
|
99
|
-
> <EmployeeResponse>
|
|
99
|
+
> <EmployeeResponse> official_create_employee20230301(create_employee_request)
|
|
100
100
|
|
|
101
|
-
Create
|
|
101
|
+
Create Employee
|
|
102
102
|
|
|
103
103
|
Creates a new Employee
|
|
104
104
|
|
|
@@ -119,29 +119,29 @@ api_instance = OpenapiClient::Class20230301Api.new
|
|
|
119
119
|
create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest |
|
|
120
120
|
|
|
121
121
|
begin
|
|
122
|
-
# Create
|
|
123
|
-
result = api_instance.
|
|
122
|
+
# Create Employee
|
|
123
|
+
result = api_instance.official_create_employee20230301(create_employee_request)
|
|
124
124
|
p result
|
|
125
125
|
rescue OpenapiClient::ApiError => e
|
|
126
|
-
puts "Error when calling Class20230301Api->
|
|
126
|
+
puts "Error when calling Class20230301Api->official_create_employee20230301: #{e}"
|
|
127
127
|
end
|
|
128
128
|
```
|
|
129
129
|
|
|
130
|
-
#### Using the
|
|
130
|
+
#### Using the official_create_employee20230301_with_http_info variant
|
|
131
131
|
|
|
132
132
|
This returns an Array which contains the response data, status code and headers.
|
|
133
133
|
|
|
134
|
-
> <Array(<EmployeeResponse>, Integer, Hash)>
|
|
134
|
+
> <Array(<EmployeeResponse>, Integer, Hash)> official_create_employee20230301_with_http_info(create_employee_request)
|
|
135
135
|
|
|
136
136
|
```ruby
|
|
137
137
|
begin
|
|
138
|
-
# Create
|
|
139
|
-
data, status_code, headers = api_instance.
|
|
138
|
+
# Create Employee
|
|
139
|
+
data, status_code, headers = api_instance.official_create_employee20230301_with_http_info(create_employee_request)
|
|
140
140
|
p status_code # => 2xx
|
|
141
141
|
p headers # => { ... }
|
|
142
142
|
p data # => <EmployeeResponse>
|
|
143
143
|
rescue OpenapiClient::ApiError => e
|
|
144
|
-
puts "Error when calling Class20230301Api->
|
|
144
|
+
puts "Error when calling Class20230301Api->official_create_employee20230301_with_http_info: #{e}"
|
|
145
145
|
end
|
|
146
146
|
```
|
|
147
147
|
|
|
@@ -165,9 +165,9 @@ end
|
|
|
165
165
|
- **Accept**: application/json
|
|
166
166
|
|
|
167
167
|
|
|
168
|
-
##
|
|
168
|
+
## official_employees20230301
|
|
169
169
|
|
|
170
|
-
> <Array<EmployeeResponse>>
|
|
170
|
+
> <Array<EmployeeResponse>> official_employees20230301
|
|
171
171
|
|
|
172
172
|
Employees
|
|
173
173
|
|
|
@@ -190,28 +190,28 @@ api_instance = OpenapiClient::Class20230301Api.new
|
|
|
190
190
|
|
|
191
191
|
begin
|
|
192
192
|
# Employees
|
|
193
|
-
result = api_instance.
|
|
193
|
+
result = api_instance.official_employees20230301
|
|
194
194
|
p result
|
|
195
195
|
rescue OpenapiClient::ApiError => e
|
|
196
|
-
puts "Error when calling Class20230301Api->
|
|
196
|
+
puts "Error when calling Class20230301Api->official_employees20230301: #{e}"
|
|
197
197
|
end
|
|
198
198
|
```
|
|
199
199
|
|
|
200
|
-
#### Using the
|
|
200
|
+
#### Using the official_employees20230301_with_http_info variant
|
|
201
201
|
|
|
202
202
|
This returns an Array which contains the response data, status code and headers.
|
|
203
203
|
|
|
204
|
-
> <Array(<Array<EmployeeResponse>>, Integer, Hash)>
|
|
204
|
+
> <Array(<Array<EmployeeResponse>>, Integer, Hash)> official_employees20230301_with_http_info
|
|
205
205
|
|
|
206
206
|
```ruby
|
|
207
207
|
begin
|
|
208
208
|
# Employees
|
|
209
|
-
data, status_code, headers = api_instance.
|
|
209
|
+
data, status_code, headers = api_instance.official_employees20230301_with_http_info
|
|
210
210
|
p status_code # => 2xx
|
|
211
211
|
p headers # => { ... }
|
|
212
212
|
p data # => <Array<EmployeeResponse>>
|
|
213
213
|
rescue OpenapiClient::ApiError => e
|
|
214
|
-
puts "Error when calling Class20230301Api->
|
|
214
|
+
puts "Error when calling Class20230301Api->official_employees20230301_with_http_info: #{e}"
|
|
215
215
|
end
|
|
216
216
|
```
|
|
217
217
|
|
|
@@ -233,9 +233,9 @@ This endpoint does not need any parameter.
|
|
|
233
233
|
- **Accept**: application/json
|
|
234
234
|
|
|
235
235
|
|
|
236
|
-
##
|
|
236
|
+
## official_groups20230301
|
|
237
237
|
|
|
238
|
-
> <Array<GroupResponse>>
|
|
238
|
+
> <Array<GroupResponse>> official_groups20230301
|
|
239
239
|
|
|
240
240
|
Groups
|
|
241
241
|
|
|
@@ -258,28 +258,28 @@ api_instance = OpenapiClient::Class20230301Api.new
|
|
|
258
258
|
|
|
259
259
|
begin
|
|
260
260
|
# Groups
|
|
261
|
-
result = api_instance.
|
|
261
|
+
result = api_instance.official_groups20230301
|
|
262
262
|
p result
|
|
263
263
|
rescue OpenapiClient::ApiError => e
|
|
264
|
-
puts "Error when calling Class20230301Api->
|
|
264
|
+
puts "Error when calling Class20230301Api->official_groups20230301: #{e}"
|
|
265
265
|
end
|
|
266
266
|
```
|
|
267
267
|
|
|
268
|
-
#### Using the
|
|
268
|
+
#### Using the official_groups20230301_with_http_info variant
|
|
269
269
|
|
|
270
270
|
This returns an Array which contains the response data, status code and headers.
|
|
271
271
|
|
|
272
|
-
> <Array(<Array<GroupResponse>>, Integer, Hash)>
|
|
272
|
+
> <Array(<Array<GroupResponse>>, Integer, Hash)> official_groups20230301_with_http_info
|
|
273
273
|
|
|
274
274
|
```ruby
|
|
275
275
|
begin
|
|
276
276
|
# Groups
|
|
277
|
-
data, status_code, headers = api_instance.
|
|
277
|
+
data, status_code, headers = api_instance.official_groups20230301_with_http_info
|
|
278
278
|
p status_code # => 2xx
|
|
279
279
|
p headers # => { ... }
|
|
280
280
|
p data # => <Array<GroupResponse>>
|
|
281
281
|
rescue OpenapiClient::ApiError => e
|
|
282
|
-
puts "Error when calling Class20230301Api->
|
|
282
|
+
puts "Error when calling Class20230301Api->official_groups20230301_with_http_info: #{e}"
|
|
283
283
|
end
|
|
284
284
|
```
|
|
285
285
|
|
|
@@ -301,13 +301,13 @@ This endpoint does not need any parameter.
|
|
|
301
301
|
- **Accept**: application/json
|
|
302
302
|
|
|
303
303
|
|
|
304
|
-
##
|
|
304
|
+
## official_time_off_balances20230301
|
|
305
305
|
|
|
306
|
-
> <
|
|
306
|
+
> <Array<TimeOffBalanceResponse>> official_time_off_balances20230301
|
|
307
307
|
|
|
308
|
-
|
|
308
|
+
Time off balances
|
|
309
309
|
|
|
310
|
-
|
|
310
|
+
Retrieve all time off balances.
|
|
311
311
|
|
|
312
312
|
### Examples
|
|
313
313
|
|
|
@@ -325,29 +325,29 @@ end
|
|
|
325
325
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
326
326
|
|
|
327
327
|
begin
|
|
328
|
-
#
|
|
329
|
-
result = api_instance.
|
|
328
|
+
# Time off balances
|
|
329
|
+
result = api_instance.official_time_off_balances20230301
|
|
330
330
|
p result
|
|
331
331
|
rescue OpenapiClient::ApiError => e
|
|
332
|
-
puts "Error when calling Class20230301Api->
|
|
332
|
+
puts "Error when calling Class20230301Api->official_time_off_balances20230301: #{e}"
|
|
333
333
|
end
|
|
334
334
|
```
|
|
335
335
|
|
|
336
|
-
#### Using the
|
|
336
|
+
#### Using the official_time_off_balances20230301_with_http_info variant
|
|
337
337
|
|
|
338
338
|
This returns an Array which contains the response data, status code and headers.
|
|
339
339
|
|
|
340
|
-
> <Array(<
|
|
340
|
+
> <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> official_time_off_balances20230301_with_http_info
|
|
341
341
|
|
|
342
342
|
```ruby
|
|
343
343
|
begin
|
|
344
|
-
#
|
|
345
|
-
data, status_code, headers = api_instance.
|
|
344
|
+
# Time off balances
|
|
345
|
+
data, status_code, headers = api_instance.official_time_off_balances20230301_with_http_info
|
|
346
346
|
p status_code # => 2xx
|
|
347
347
|
p headers # => { ... }
|
|
348
|
-
p data # => <
|
|
348
|
+
p data # => <Array<TimeOffBalanceResponse>>
|
|
349
349
|
rescue OpenapiClient::ApiError => e
|
|
350
|
-
puts "Error when calling Class20230301Api->
|
|
350
|
+
puts "Error when calling Class20230301Api->official_time_off_balances20230301_with_http_info: #{e}"
|
|
351
351
|
end
|
|
352
352
|
```
|
|
353
353
|
|
|
@@ -357,7 +357,7 @@ This endpoint does not need any parameter.
|
|
|
357
357
|
|
|
358
358
|
### Return type
|
|
359
359
|
|
|
360
|
-
[**
|
|
360
|
+
[**Array<TimeOffBalanceResponse>**](TimeOffBalanceResponse.md)
|
|
361
361
|
|
|
362
362
|
### Authorization
|
|
363
363
|
|
|
@@ -369,13 +369,13 @@ This endpoint does not need any parameter.
|
|
|
369
369
|
- **Accept**: application/json
|
|
370
370
|
|
|
371
371
|
|
|
372
|
-
##
|
|
372
|
+
## official_time_off_entries20230301
|
|
373
373
|
|
|
374
|
-
> <Array<
|
|
374
|
+
> <Array<TimeOffEntryResponse>> official_time_off_entries20230301
|
|
375
375
|
|
|
376
|
-
|
|
376
|
+
Time off entries
|
|
377
377
|
|
|
378
|
-
|
|
378
|
+
Retrieve time off / absence entries
|
|
379
379
|
|
|
380
380
|
### Examples
|
|
381
381
|
|
|
@@ -391,46 +391,41 @@ OpenapiClient.configure do |config|
|
|
|
391
391
|
end
|
|
392
392
|
|
|
393
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
394
|
|
|
397
395
|
begin
|
|
398
|
-
#
|
|
399
|
-
result = api_instance.
|
|
396
|
+
# Time off entries
|
|
397
|
+
result = api_instance.official_time_off_entries20230301
|
|
400
398
|
p result
|
|
401
399
|
rescue OpenapiClient::ApiError => e
|
|
402
|
-
puts "Error when calling Class20230301Api->
|
|
400
|
+
puts "Error when calling Class20230301Api->official_time_off_entries20230301: #{e}"
|
|
403
401
|
end
|
|
404
402
|
```
|
|
405
403
|
|
|
406
|
-
#### Using the
|
|
404
|
+
#### Using the official_time_off_entries20230301_with_http_info variant
|
|
407
405
|
|
|
408
406
|
This returns an Array which contains the response data, status code and headers.
|
|
409
407
|
|
|
410
|
-
> <Array(<Array<
|
|
408
|
+
> <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> official_time_off_entries20230301_with_http_info
|
|
411
409
|
|
|
412
410
|
```ruby
|
|
413
411
|
begin
|
|
414
|
-
#
|
|
415
|
-
data, status_code, headers = api_instance.
|
|
412
|
+
# Time off entries
|
|
413
|
+
data, status_code, headers = api_instance.official_time_off_entries20230301_with_http_info
|
|
416
414
|
p status_code # => 2xx
|
|
417
415
|
p headers # => { ... }
|
|
418
|
-
p data # => <Array<
|
|
416
|
+
p data # => <Array<TimeOffEntryResponse>>
|
|
419
417
|
rescue OpenapiClient::ApiError => e
|
|
420
|
-
puts "Error when calling Class20230301Api->
|
|
418
|
+
puts "Error when calling Class20230301Api->official_time_off_entries20230301_with_http_info: #{e}"
|
|
421
419
|
end
|
|
422
420
|
```
|
|
423
421
|
|
|
424
422
|
### Parameters
|
|
425
423
|
|
|
426
|
-
|
|
427
|
-
| ---- | ---- | ----------- | ----- |
|
|
428
|
-
| **start_date** | **Date** | The start date of the search period | |
|
|
429
|
-
| **end_date** | **Date** | The end date of the search period | |
|
|
424
|
+
This endpoint does not need any parameter.
|
|
430
425
|
|
|
431
426
|
### Return type
|
|
432
427
|
|
|
433
|
-
[**Array<
|
|
428
|
+
[**Array<TimeOffEntryResponse>**](TimeOffEntryResponse.md)
|
|
434
429
|
|
|
435
430
|
### Authorization
|
|
436
431
|
|
|
@@ -442,13 +437,13 @@ end
|
|
|
442
437
|
- **Accept**: application/json
|
|
443
438
|
|
|
444
439
|
|
|
445
|
-
##
|
|
440
|
+
## official_timesheets20230301
|
|
446
441
|
|
|
447
|
-
> <Array<
|
|
442
|
+
> <Array<TimesheetResponse>> official_timesheets20230301
|
|
448
443
|
|
|
449
|
-
|
|
444
|
+
Timesheets
|
|
450
445
|
|
|
451
|
-
|
|
446
|
+
Retrieve Timesheets
|
|
452
447
|
|
|
453
448
|
### Examples
|
|
454
449
|
|
|
@@ -464,44 +459,41 @@ OpenapiClient.configure do |config|
|
|
|
464
459
|
end
|
|
465
460
|
|
|
466
461
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
467
|
-
payrun_id = 'payrun_id_example' # String | The id of the payrun.
|
|
468
462
|
|
|
469
463
|
begin
|
|
470
|
-
#
|
|
471
|
-
result = api_instance.
|
|
464
|
+
# Timesheets
|
|
465
|
+
result = api_instance.official_timesheets20230301
|
|
472
466
|
p result
|
|
473
467
|
rescue OpenapiClient::ApiError => e
|
|
474
|
-
puts "Error when calling Class20230301Api->
|
|
468
|
+
puts "Error when calling Class20230301Api->official_timesheets20230301: #{e}"
|
|
475
469
|
end
|
|
476
470
|
```
|
|
477
471
|
|
|
478
|
-
#### Using the
|
|
472
|
+
#### Using the official_timesheets20230301_with_http_info variant
|
|
479
473
|
|
|
480
474
|
This returns an Array which contains the response data, status code and headers.
|
|
481
475
|
|
|
482
|
-
> <Array(<Array<
|
|
476
|
+
> <Array(<Array<TimesheetResponse>>, Integer, Hash)> official_timesheets20230301_with_http_info
|
|
483
477
|
|
|
484
478
|
```ruby
|
|
485
479
|
begin
|
|
486
|
-
#
|
|
487
|
-
data, status_code, headers = api_instance.
|
|
480
|
+
# Timesheets
|
|
481
|
+
data, status_code, headers = api_instance.official_timesheets20230301_with_http_info
|
|
488
482
|
p status_code # => 2xx
|
|
489
483
|
p headers # => { ... }
|
|
490
|
-
p data # => <Array<
|
|
484
|
+
p data # => <Array<TimesheetResponse>>
|
|
491
485
|
rescue OpenapiClient::ApiError => e
|
|
492
|
-
puts "Error when calling Class20230301Api->
|
|
486
|
+
puts "Error when calling Class20230301Api->official_timesheets20230301_with_http_info: #{e}"
|
|
493
487
|
end
|
|
494
488
|
```
|
|
495
489
|
|
|
496
490
|
### Parameters
|
|
497
491
|
|
|
498
|
-
|
|
499
|
-
| ---- | ---- | ----------- | ----- |
|
|
500
|
-
| **payrun_id** | **String** | The id of the payrun. | |
|
|
492
|
+
This endpoint does not need any parameter.
|
|
501
493
|
|
|
502
494
|
### Return type
|
|
503
495
|
|
|
504
|
-
[**Array<
|
|
496
|
+
[**Array<TimesheetResponse>**](TimesheetResponse.md)
|
|
505
497
|
|
|
506
498
|
### Authorization
|
|
507
499
|
|
|
@@ -513,13 +505,13 @@ end
|
|
|
513
505
|
- **Accept**: application/json
|
|
514
506
|
|
|
515
507
|
|
|
516
|
-
##
|
|
508
|
+
## official_work_locations20230301
|
|
517
509
|
|
|
518
|
-
> <Array<
|
|
510
|
+
> <Array<LocationResponse>> official_work_locations20230301
|
|
519
511
|
|
|
520
|
-
|
|
512
|
+
Work locations
|
|
521
513
|
|
|
522
|
-
|
|
514
|
+
The Location object is used to represent an address that can be associated with an employee
|
|
523
515
|
|
|
524
516
|
### Examples
|
|
525
517
|
|
|
@@ -537,29 +529,29 @@ end
|
|
|
537
529
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
538
530
|
|
|
539
531
|
begin
|
|
540
|
-
#
|
|
541
|
-
result = api_instance.
|
|
532
|
+
# Work locations
|
|
533
|
+
result = api_instance.official_work_locations20230301
|
|
542
534
|
p result
|
|
543
535
|
rescue OpenapiClient::ApiError => e
|
|
544
|
-
puts "Error when calling Class20230301Api->
|
|
536
|
+
puts "Error when calling Class20230301Api->official_work_locations20230301: #{e}"
|
|
545
537
|
end
|
|
546
538
|
```
|
|
547
539
|
|
|
548
|
-
#### Using the
|
|
540
|
+
#### Using the official_work_locations20230301_with_http_info variant
|
|
549
541
|
|
|
550
542
|
This returns an Array which contains the response data, status code and headers.
|
|
551
543
|
|
|
552
|
-
> <Array(<Array<
|
|
544
|
+
> <Array(<Array<LocationResponse>>, Integer, Hash)> official_work_locations20230301_with_http_info
|
|
553
545
|
|
|
554
546
|
```ruby
|
|
555
547
|
begin
|
|
556
|
-
#
|
|
557
|
-
data, status_code, headers = api_instance.
|
|
548
|
+
# Work locations
|
|
549
|
+
data, status_code, headers = api_instance.official_work_locations20230301_with_http_info
|
|
558
550
|
p status_code # => 2xx
|
|
559
551
|
p headers # => { ... }
|
|
560
|
-
p data # => <Array<
|
|
552
|
+
p data # => <Array<LocationResponse>>
|
|
561
553
|
rescue OpenapiClient::ApiError => e
|
|
562
|
-
puts "Error when calling Class20230301Api->
|
|
554
|
+
puts "Error when calling Class20230301Api->official_work_locations20230301_with_http_info: #{e}"
|
|
563
555
|
end
|
|
564
556
|
```
|
|
565
557
|
|
|
@@ -569,7 +561,7 @@ This endpoint does not need any parameter.
|
|
|
569
561
|
|
|
570
562
|
### Return type
|
|
571
563
|
|
|
572
|
-
[**Array<
|
|
564
|
+
[**Array<LocationResponse>**](LocationResponse.md)
|
|
573
565
|
|
|
574
566
|
### Authorization
|
|
575
567
|
|
|
@@ -581,13 +573,13 @@ This endpoint does not need any parameter.
|
|
|
581
573
|
- **Accept**: application/json
|
|
582
574
|
|
|
583
575
|
|
|
584
|
-
##
|
|
576
|
+
## officialdentity20230301
|
|
585
577
|
|
|
586
|
-
> <
|
|
578
|
+
> <IdentityResponse> officialdentity20230301
|
|
587
579
|
|
|
588
|
-
|
|
580
|
+
Identity
|
|
589
581
|
|
|
590
|
-
|
|
582
|
+
List information of the user for the respective account
|
|
591
583
|
|
|
592
584
|
### Examples
|
|
593
585
|
|
|
@@ -605,29 +597,29 @@ end
|
|
|
605
597
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
606
598
|
|
|
607
599
|
begin
|
|
608
|
-
#
|
|
609
|
-
result = api_instance.
|
|
600
|
+
# Identity
|
|
601
|
+
result = api_instance.officialdentity20230301
|
|
610
602
|
p result
|
|
611
603
|
rescue OpenapiClient::ApiError => e
|
|
612
|
-
puts "Error when calling Class20230301Api->
|
|
604
|
+
puts "Error when calling Class20230301Api->officialdentity20230301: #{e}"
|
|
613
605
|
end
|
|
614
606
|
```
|
|
615
607
|
|
|
616
|
-
#### Using the
|
|
608
|
+
#### Using the officialdentity20230301_with_http_info variant
|
|
617
609
|
|
|
618
610
|
This returns an Array which contains the response data, status code and headers.
|
|
619
611
|
|
|
620
|
-
> <Array(<
|
|
612
|
+
> <Array(<IdentityResponse>, Integer, Hash)> officialdentity20230301_with_http_info
|
|
621
613
|
|
|
622
614
|
```ruby
|
|
623
615
|
begin
|
|
624
|
-
#
|
|
625
|
-
data, status_code, headers = api_instance.
|
|
616
|
+
# Identity
|
|
617
|
+
data, status_code, headers = api_instance.officialdentity20230301_with_http_info
|
|
626
618
|
p status_code # => 2xx
|
|
627
619
|
p headers # => { ... }
|
|
628
|
-
p data # => <
|
|
620
|
+
p data # => <IdentityResponse>
|
|
629
621
|
rescue OpenapiClient::ApiError => e
|
|
630
|
-
puts "Error when calling Class20230301Api->
|
|
622
|
+
puts "Error when calling Class20230301Api->officialdentity20230301_with_http_info: #{e}"
|
|
631
623
|
end
|
|
632
624
|
```
|
|
633
625
|
|
|
@@ -637,7 +629,7 @@ This endpoint does not need any parameter.
|
|
|
637
629
|
|
|
638
630
|
### Return type
|
|
639
631
|
|
|
640
|
-
[**
|
|
632
|
+
[**IdentityResponse**](IdentityResponse.md)
|
|
641
633
|
|
|
642
634
|
### Authorization
|
|
643
635
|
|
|
@@ -649,13 +641,13 @@ This endpoint does not need any parameter.
|
|
|
649
641
|
- **Accept**: application/json
|
|
650
642
|
|
|
651
643
|
|
|
652
|
-
##
|
|
644
|
+
## xhr_companies20230301
|
|
653
645
|
|
|
654
|
-
> <Array<
|
|
646
|
+
> <Array<CompanyResponse>> xhr_companies20230301
|
|
655
647
|
|
|
656
|
-
|
|
648
|
+
Company
|
|
657
649
|
|
|
658
|
-
Retrieve
|
|
650
|
+
Retrieve company information
|
|
659
651
|
|
|
660
652
|
### Examples
|
|
661
653
|
|
|
@@ -673,29 +665,29 @@ end
|
|
|
673
665
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
674
666
|
|
|
675
667
|
begin
|
|
676
|
-
#
|
|
677
|
-
result = api_instance.
|
|
668
|
+
# Company
|
|
669
|
+
result = api_instance.xhr_companies20230301
|
|
678
670
|
p result
|
|
679
671
|
rescue OpenapiClient::ApiError => e
|
|
680
|
-
puts "Error when calling Class20230301Api->
|
|
672
|
+
puts "Error when calling Class20230301Api->xhr_companies20230301: #{e}"
|
|
681
673
|
end
|
|
682
674
|
```
|
|
683
675
|
|
|
684
|
-
#### Using the
|
|
676
|
+
#### Using the xhr_companies20230301_with_http_info variant
|
|
685
677
|
|
|
686
678
|
This returns an Array which contains the response data, status code and headers.
|
|
687
679
|
|
|
688
|
-
> <Array(<Array<
|
|
680
|
+
> <Array(<Array<CompanyResponse>>, Integer, Hash)> xhr_companies20230301_with_http_info
|
|
689
681
|
|
|
690
682
|
```ruby
|
|
691
683
|
begin
|
|
692
|
-
#
|
|
693
|
-
data, status_code, headers = api_instance.
|
|
684
|
+
# Company
|
|
685
|
+
data, status_code, headers = api_instance.xhr_companies20230301_with_http_info
|
|
694
686
|
p status_code # => 2xx
|
|
695
687
|
p headers # => { ... }
|
|
696
|
-
p data # => <Array<
|
|
688
|
+
p data # => <Array<CompanyResponse>>
|
|
697
689
|
rescue OpenapiClient::ApiError => e
|
|
698
|
-
puts "Error when calling Class20230301Api->
|
|
690
|
+
puts "Error when calling Class20230301Api->xhr_companies20230301_with_http_info: #{e}"
|
|
699
691
|
end
|
|
700
692
|
```
|
|
701
693
|
|
|
@@ -705,7 +697,7 @@ This endpoint does not need any parameter.
|
|
|
705
697
|
|
|
706
698
|
### Return type
|
|
707
699
|
|
|
708
|
-
[**Array<
|
|
700
|
+
[**Array<CompanyResponse>**](CompanyResponse.md)
|
|
709
701
|
|
|
710
702
|
### Authorization
|
|
711
703
|
|
|
@@ -717,13 +709,13 @@ This endpoint does not need any parameter.
|
|
|
717
709
|
- **Accept**: application/json
|
|
718
710
|
|
|
719
711
|
|
|
720
|
-
##
|
|
712
|
+
## xhr_create_employee20230301
|
|
721
713
|
|
|
722
|
-
> <
|
|
714
|
+
> <EmployeeResponse> xhr_create_employee20230301(create_employee_request)
|
|
723
715
|
|
|
724
|
-
|
|
716
|
+
Create employee
|
|
725
717
|
|
|
726
|
-
|
|
718
|
+
Creates a new Employee
|
|
727
719
|
|
|
728
720
|
### Examples
|
|
729
721
|
|
|
@@ -739,41 +731,44 @@ OpenapiClient.configure do |config|
|
|
|
739
731
|
end
|
|
740
732
|
|
|
741
733
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
734
|
+
create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest |
|
|
742
735
|
|
|
743
736
|
begin
|
|
744
|
-
#
|
|
745
|
-
result = api_instance.
|
|
737
|
+
# Create employee
|
|
738
|
+
result = api_instance.xhr_create_employee20230301(create_employee_request)
|
|
746
739
|
p result
|
|
747
740
|
rescue OpenapiClient::ApiError => e
|
|
748
|
-
puts "Error when calling Class20230301Api->
|
|
741
|
+
puts "Error when calling Class20230301Api->xhr_create_employee20230301: #{e}"
|
|
749
742
|
end
|
|
750
743
|
```
|
|
751
744
|
|
|
752
|
-
#### Using the
|
|
745
|
+
#### Using the xhr_create_employee20230301_with_http_info variant
|
|
753
746
|
|
|
754
747
|
This returns an Array which contains the response data, status code and headers.
|
|
755
748
|
|
|
756
|
-
> <Array(<
|
|
749
|
+
> <Array(<EmployeeResponse>, Integer, Hash)> xhr_create_employee20230301_with_http_info(create_employee_request)
|
|
757
750
|
|
|
758
751
|
```ruby
|
|
759
752
|
begin
|
|
760
|
-
#
|
|
761
|
-
data, status_code, headers = api_instance.
|
|
753
|
+
# Create employee
|
|
754
|
+
data, status_code, headers = api_instance.xhr_create_employee20230301_with_http_info(create_employee_request)
|
|
762
755
|
p status_code # => 2xx
|
|
763
756
|
p headers # => { ... }
|
|
764
|
-
p data # => <
|
|
757
|
+
p data # => <EmployeeResponse>
|
|
765
758
|
rescue OpenapiClient::ApiError => e
|
|
766
|
-
puts "Error when calling Class20230301Api->
|
|
759
|
+
puts "Error when calling Class20230301Api->xhr_create_employee20230301_with_http_info: #{e}"
|
|
767
760
|
end
|
|
768
761
|
```
|
|
769
762
|
|
|
770
763
|
### Parameters
|
|
771
764
|
|
|
772
|
-
|
|
765
|
+
| Name | Type | Description | Notes |
|
|
766
|
+
| ---- | ---- | ----------- | ----- |
|
|
767
|
+
| **create_employee_request** | [**CreateEmployeeRequest**](CreateEmployeeRequest.md) | | |
|
|
773
768
|
|
|
774
769
|
### Return type
|
|
775
770
|
|
|
776
|
-
[**
|
|
771
|
+
[**EmployeeResponse**](EmployeeResponse.md)
|
|
777
772
|
|
|
778
773
|
### Authorization
|
|
779
774
|
|
|
@@ -781,17 +776,17 @@ This endpoint does not need any parameter.
|
|
|
781
776
|
|
|
782
777
|
### HTTP request headers
|
|
783
778
|
|
|
784
|
-
- **Content-Type**:
|
|
779
|
+
- **Content-Type**: application/json
|
|
785
780
|
- **Accept**: application/json
|
|
786
781
|
|
|
787
782
|
|
|
788
|
-
##
|
|
783
|
+
## xhr_employees20230301
|
|
789
784
|
|
|
790
|
-
> <Array<
|
|
785
|
+
> <Array<EmployeeResponse>> xhr_employees20230301
|
|
791
786
|
|
|
792
|
-
|
|
787
|
+
Employees
|
|
793
788
|
|
|
794
|
-
|
|
789
|
+
List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
|
795
790
|
|
|
796
791
|
### Examples
|
|
797
792
|
|
|
@@ -809,29 +804,29 @@ end
|
|
|
809
804
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
810
805
|
|
|
811
806
|
begin
|
|
812
|
-
#
|
|
813
|
-
result = api_instance.
|
|
807
|
+
# Employees
|
|
808
|
+
result = api_instance.xhr_employees20230301
|
|
814
809
|
p result
|
|
815
810
|
rescue OpenapiClient::ApiError => e
|
|
816
|
-
puts "Error when calling Class20230301Api->
|
|
811
|
+
puts "Error when calling Class20230301Api->xhr_employees20230301: #{e}"
|
|
817
812
|
end
|
|
818
813
|
```
|
|
819
814
|
|
|
820
|
-
#### Using the
|
|
815
|
+
#### Using the xhr_employees20230301_with_http_info variant
|
|
821
816
|
|
|
822
817
|
This returns an Array which contains the response data, status code and headers.
|
|
823
818
|
|
|
824
|
-
> <Array(<Array<
|
|
819
|
+
> <Array(<Array<EmployeeResponse>>, Integer, Hash)> xhr_employees20230301_with_http_info
|
|
825
820
|
|
|
826
821
|
```ruby
|
|
827
822
|
begin
|
|
828
|
-
#
|
|
829
|
-
data, status_code, headers = api_instance.
|
|
823
|
+
# Employees
|
|
824
|
+
data, status_code, headers = api_instance.xhr_employees20230301_with_http_info
|
|
830
825
|
p status_code # => 2xx
|
|
831
826
|
p headers # => { ... }
|
|
832
|
-
p data # => <Array<
|
|
827
|
+
p data # => <Array<EmployeeResponse>>
|
|
833
828
|
rescue OpenapiClient::ApiError => e
|
|
834
|
-
puts "Error when calling Class20230301Api->
|
|
829
|
+
puts "Error when calling Class20230301Api->xhr_employees20230301_with_http_info: #{e}"
|
|
835
830
|
end
|
|
836
831
|
```
|
|
837
832
|
|
|
@@ -841,7 +836,7 @@ This endpoint does not need any parameter.
|
|
|
841
836
|
|
|
842
837
|
### Return type
|
|
843
838
|
|
|
844
|
-
[**Array<
|
|
839
|
+
[**Array<EmployeeResponse>**](EmployeeResponse.md)
|
|
845
840
|
|
|
846
841
|
### Authorization
|
|
847
842
|
|
|
@@ -853,13 +848,13 @@ This endpoint does not need any parameter.
|
|
|
853
848
|
- **Accept**: application/json
|
|
854
849
|
|
|
855
850
|
|
|
856
|
-
##
|
|
851
|
+
## xhr_groups20230301
|
|
857
852
|
|
|
858
|
-
> <
|
|
853
|
+
> <Array<GroupResponse>> xhr_groups20230301
|
|
859
854
|
|
|
860
|
-
|
|
855
|
+
Groups
|
|
861
856
|
|
|
862
|
-
|
|
857
|
+
The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
|
863
858
|
|
|
864
859
|
### Examples
|
|
865
860
|
|
|
@@ -875,44 +870,41 @@ OpenapiClient.configure do |config|
|
|
|
875
870
|
end
|
|
876
871
|
|
|
877
872
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
878
|
-
create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name: 'Greg', last_name: 'Hirsch'}) # CreateEmployeeRequest |
|
|
879
873
|
|
|
880
874
|
begin
|
|
881
|
-
#
|
|
882
|
-
result = api_instance.
|
|
875
|
+
# Groups
|
|
876
|
+
result = api_instance.xhr_groups20230301
|
|
883
877
|
p result
|
|
884
878
|
rescue OpenapiClient::ApiError => e
|
|
885
|
-
puts "Error when calling Class20230301Api->
|
|
879
|
+
puts "Error when calling Class20230301Api->xhr_groups20230301: #{e}"
|
|
886
880
|
end
|
|
887
881
|
```
|
|
888
882
|
|
|
889
|
-
#### Using the
|
|
883
|
+
#### Using the xhr_groups20230301_with_http_info variant
|
|
890
884
|
|
|
891
885
|
This returns an Array which contains the response data, status code and headers.
|
|
892
886
|
|
|
893
|
-
> <Array(<
|
|
887
|
+
> <Array(<Array<GroupResponse>>, Integer, Hash)> xhr_groups20230301_with_http_info
|
|
894
888
|
|
|
895
889
|
```ruby
|
|
896
890
|
begin
|
|
897
|
-
#
|
|
898
|
-
data, status_code, headers = api_instance.
|
|
891
|
+
# Groups
|
|
892
|
+
data, status_code, headers = api_instance.xhr_groups20230301_with_http_info
|
|
899
893
|
p status_code # => 2xx
|
|
900
894
|
p headers # => { ... }
|
|
901
|
-
p data # => <
|
|
895
|
+
p data # => <Array<GroupResponse>>
|
|
902
896
|
rescue OpenapiClient::ApiError => e
|
|
903
|
-
puts "Error when calling Class20230301Api->
|
|
897
|
+
puts "Error when calling Class20230301Api->xhr_groups20230301_with_http_info: #{e}"
|
|
904
898
|
end
|
|
905
899
|
```
|
|
906
900
|
|
|
907
901
|
### Parameters
|
|
908
902
|
|
|
909
|
-
|
|
910
|
-
| ---- | ---- | ----------- | ----- |
|
|
911
|
-
| **create_employee_request** | [**CreateEmployeeRequest**](CreateEmployeeRequest.md) | | |
|
|
903
|
+
This endpoint does not need any parameter.
|
|
912
904
|
|
|
913
905
|
### Return type
|
|
914
906
|
|
|
915
|
-
[**
|
|
907
|
+
[**Array<GroupResponse>**](GroupResponse.md)
|
|
916
908
|
|
|
917
909
|
### Authorization
|
|
918
910
|
|
|
@@ -920,17 +912,17 @@ end
|
|
|
920
912
|
|
|
921
913
|
### HTTP request headers
|
|
922
914
|
|
|
923
|
-
- **Content-Type**:
|
|
915
|
+
- **Content-Type**: Not defined
|
|
924
916
|
- **Accept**: application/json
|
|
925
917
|
|
|
926
918
|
|
|
927
|
-
##
|
|
919
|
+
## xhr_identity20230301
|
|
928
920
|
|
|
929
|
-
> <
|
|
921
|
+
> <IdentityResponse> xhr_identity20230301
|
|
930
922
|
|
|
931
|
-
|
|
923
|
+
Identity
|
|
932
924
|
|
|
933
|
-
List
|
|
925
|
+
List information of the user for the respective account
|
|
934
926
|
|
|
935
927
|
### Examples
|
|
936
928
|
|
|
@@ -948,29 +940,29 @@ end
|
|
|
948
940
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
949
941
|
|
|
950
942
|
begin
|
|
951
|
-
#
|
|
952
|
-
result = api_instance.
|
|
943
|
+
# Identity
|
|
944
|
+
result = api_instance.xhr_identity20230301
|
|
953
945
|
p result
|
|
954
946
|
rescue OpenapiClient::ApiError => e
|
|
955
|
-
puts "Error when calling Class20230301Api->
|
|
947
|
+
puts "Error when calling Class20230301Api->xhr_identity20230301: #{e}"
|
|
956
948
|
end
|
|
957
949
|
```
|
|
958
950
|
|
|
959
|
-
#### Using the
|
|
951
|
+
#### Using the xhr_identity20230301_with_http_info variant
|
|
960
952
|
|
|
961
953
|
This returns an Array which contains the response data, status code and headers.
|
|
962
954
|
|
|
963
|
-
> <Array(<
|
|
955
|
+
> <Array(<IdentityResponse>, Integer, Hash)> xhr_identity20230301_with_http_info
|
|
964
956
|
|
|
965
957
|
```ruby
|
|
966
958
|
begin
|
|
967
|
-
#
|
|
968
|
-
data, status_code, headers = api_instance.
|
|
959
|
+
# Identity
|
|
960
|
+
data, status_code, headers = api_instance.xhr_identity20230301_with_http_info
|
|
969
961
|
p status_code # => 2xx
|
|
970
962
|
p headers # => { ... }
|
|
971
|
-
p data # => <
|
|
963
|
+
p data # => <IdentityResponse>
|
|
972
964
|
rescue OpenapiClient::ApiError => e
|
|
973
|
-
puts "Error when calling Class20230301Api->
|
|
965
|
+
puts "Error when calling Class20230301Api->xhr_identity20230301_with_http_info: #{e}"
|
|
974
966
|
end
|
|
975
967
|
```
|
|
976
968
|
|
|
@@ -980,7 +972,7 @@ This endpoint does not need any parameter.
|
|
|
980
972
|
|
|
981
973
|
### Return type
|
|
982
974
|
|
|
983
|
-
[**
|
|
975
|
+
[**IdentityResponse**](IdentityResponse.md)
|
|
984
976
|
|
|
985
977
|
### Authorization
|
|
986
978
|
|
|
@@ -992,13 +984,13 @@ This endpoint does not need any parameter.
|
|
|
992
984
|
- **Accept**: application/json
|
|
993
985
|
|
|
994
986
|
|
|
995
|
-
##
|
|
987
|
+
## xhr_payruns20230301
|
|
996
988
|
|
|
997
|
-
> <Array<
|
|
989
|
+
> <Array<PayrunResponse>> xhr_payruns20230301(start_date, end_date)
|
|
998
990
|
|
|
999
|
-
|
|
991
|
+
Payruns
|
|
1000
992
|
|
|
1001
|
-
|
|
993
|
+
List all the pay runs that occurred during the respective period. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
|
1002
994
|
|
|
1003
995
|
### Examples
|
|
1004
996
|
|
|
@@ -1014,41 +1006,46 @@ OpenapiClient.configure do |config|
|
|
|
1014
1006
|
end
|
|
1015
1007
|
|
|
1016
1008
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
1009
|
+
start_date = Date.parse('2013-10-20') # Date | The start date of the search period
|
|
1010
|
+
end_date = Date.parse('2013-10-20') # Date | The end date of the search period
|
|
1017
1011
|
|
|
1018
1012
|
begin
|
|
1019
|
-
#
|
|
1020
|
-
result = api_instance.
|
|
1013
|
+
# Payruns
|
|
1014
|
+
result = api_instance.xhr_payruns20230301(start_date, end_date)
|
|
1021
1015
|
p result
|
|
1022
1016
|
rescue OpenapiClient::ApiError => e
|
|
1023
|
-
puts "Error when calling Class20230301Api->
|
|
1017
|
+
puts "Error when calling Class20230301Api->xhr_payruns20230301: #{e}"
|
|
1024
1018
|
end
|
|
1025
1019
|
```
|
|
1026
1020
|
|
|
1027
|
-
#### Using the
|
|
1021
|
+
#### Using the xhr_payruns20230301_with_http_info variant
|
|
1028
1022
|
|
|
1029
1023
|
This returns an Array which contains the response data, status code and headers.
|
|
1030
1024
|
|
|
1031
|
-
> <Array(<Array<
|
|
1025
|
+
> <Array(<Array<PayrunResponse>>, Integer, Hash)> xhr_payruns20230301_with_http_info(start_date, end_date)
|
|
1032
1026
|
|
|
1033
1027
|
```ruby
|
|
1034
1028
|
begin
|
|
1035
|
-
#
|
|
1036
|
-
data, status_code, headers = api_instance.
|
|
1029
|
+
# Payruns
|
|
1030
|
+
data, status_code, headers = api_instance.xhr_payruns20230301_with_http_info(start_date, end_date)
|
|
1037
1031
|
p status_code # => 2xx
|
|
1038
1032
|
p headers # => { ... }
|
|
1039
|
-
p data # => <Array<
|
|
1033
|
+
p data # => <Array<PayrunResponse>>
|
|
1040
1034
|
rescue OpenapiClient::ApiError => e
|
|
1041
|
-
puts "Error when calling Class20230301Api->
|
|
1035
|
+
puts "Error when calling Class20230301Api->xhr_payruns20230301_with_http_info: #{e}"
|
|
1042
1036
|
end
|
|
1043
1037
|
```
|
|
1044
1038
|
|
|
1045
1039
|
### Parameters
|
|
1046
1040
|
|
|
1047
|
-
|
|
1041
|
+
| Name | Type | Description | Notes |
|
|
1042
|
+
| ---- | ---- | ----------- | ----- |
|
|
1043
|
+
| **start_date** | **Date** | The start date of the search period | |
|
|
1044
|
+
| **end_date** | **Date** | The end date of the search period | |
|
|
1048
1045
|
|
|
1049
1046
|
### Return type
|
|
1050
1047
|
|
|
1051
|
-
[**Array<
|
|
1048
|
+
[**Array<PayrunResponse>**](PayrunResponse.md)
|
|
1052
1049
|
|
|
1053
1050
|
### Authorization
|
|
1054
1051
|
|
|
@@ -1060,13 +1057,13 @@ This endpoint does not need any parameter.
|
|
|
1060
1057
|
- **Accept**: application/json
|
|
1061
1058
|
|
|
1062
1059
|
|
|
1063
|
-
##
|
|
1060
|
+
## xhr_payslips20230301
|
|
1064
1061
|
|
|
1065
|
-
> <Array<
|
|
1062
|
+
> <Array<PayslipResponse>> xhr_payslips20230301(payrun_id)
|
|
1066
1063
|
|
|
1067
|
-
|
|
1064
|
+
Payslips
|
|
1068
1065
|
|
|
1069
|
-
|
|
1066
|
+
Retrieves payslips from a specific payrun. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
|
1070
1067
|
|
|
1071
1068
|
### Examples
|
|
1072
1069
|
|
|
@@ -1082,41 +1079,44 @@ OpenapiClient.configure do |config|
|
|
|
1082
1079
|
end
|
|
1083
1080
|
|
|
1084
1081
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
1082
|
+
payrun_id = 'payrun_id_example' # String | The id of the payrun.
|
|
1085
1083
|
|
|
1086
1084
|
begin
|
|
1087
|
-
#
|
|
1088
|
-
result = api_instance.
|
|
1085
|
+
# Payslips
|
|
1086
|
+
result = api_instance.xhr_payslips20230301(payrun_id)
|
|
1089
1087
|
p result
|
|
1090
1088
|
rescue OpenapiClient::ApiError => e
|
|
1091
|
-
puts "Error when calling Class20230301Api->
|
|
1089
|
+
puts "Error when calling Class20230301Api->xhr_payslips20230301: #{e}"
|
|
1092
1090
|
end
|
|
1093
1091
|
```
|
|
1094
1092
|
|
|
1095
|
-
#### Using the
|
|
1093
|
+
#### Using the xhr_payslips20230301_with_http_info variant
|
|
1096
1094
|
|
|
1097
1095
|
This returns an Array which contains the response data, status code and headers.
|
|
1098
1096
|
|
|
1099
|
-
> <Array(<Array<
|
|
1097
|
+
> <Array(<Array<PayslipResponse>>, Integer, Hash)> xhr_payslips20230301_with_http_info(payrun_id)
|
|
1100
1098
|
|
|
1101
1099
|
```ruby
|
|
1102
1100
|
begin
|
|
1103
|
-
#
|
|
1104
|
-
data, status_code, headers = api_instance.
|
|
1101
|
+
# Payslips
|
|
1102
|
+
data, status_code, headers = api_instance.xhr_payslips20230301_with_http_info(payrun_id)
|
|
1105
1103
|
p status_code # => 2xx
|
|
1106
1104
|
p headers # => { ... }
|
|
1107
|
-
p data # => <Array<
|
|
1105
|
+
p data # => <Array<PayslipResponse>>
|
|
1108
1106
|
rescue OpenapiClient::ApiError => e
|
|
1109
|
-
puts "Error when calling Class20230301Api->
|
|
1107
|
+
puts "Error when calling Class20230301Api->xhr_payslips20230301_with_http_info: #{e}"
|
|
1110
1108
|
end
|
|
1111
1109
|
```
|
|
1112
1110
|
|
|
1113
1111
|
### Parameters
|
|
1114
1112
|
|
|
1115
|
-
|
|
1113
|
+
| Name | Type | Description | Notes |
|
|
1114
|
+
| ---- | ---- | ----------- | ----- |
|
|
1115
|
+
| **payrun_id** | **String** | The id of the payrun. | |
|
|
1116
1116
|
|
|
1117
1117
|
### Return type
|
|
1118
1118
|
|
|
1119
|
-
[**Array<
|
|
1119
|
+
[**Array<PayslipResponse>**](PayslipResponse.md)
|
|
1120
1120
|
|
|
1121
1121
|
### Authorization
|
|
1122
1122
|
|
|
@@ -1128,13 +1128,13 @@ This endpoint does not need any parameter.
|
|
|
1128
1128
|
- **Accept**: application/json
|
|
1129
1129
|
|
|
1130
1130
|
|
|
1131
|
-
##
|
|
1131
|
+
## xhr_time_off_balances20230301
|
|
1132
1132
|
|
|
1133
|
-
> <Array<
|
|
1133
|
+
> <Array<TimeOffBalanceResponse>> xhr_time_off_balances20230301
|
|
1134
1134
|
|
|
1135
|
-
Time off
|
|
1135
|
+
Time off balances
|
|
1136
1136
|
|
|
1137
|
-
Retrieve time off
|
|
1137
|
+
Retrieve all time off balances.
|
|
1138
1138
|
|
|
1139
1139
|
### Examples
|
|
1140
1140
|
|
|
@@ -1152,29 +1152,29 @@ end
|
|
|
1152
1152
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
1153
1153
|
|
|
1154
1154
|
begin
|
|
1155
|
-
# Time off
|
|
1156
|
-
result = api_instance.
|
|
1155
|
+
# Time off balances
|
|
1156
|
+
result = api_instance.xhr_time_off_balances20230301
|
|
1157
1157
|
p result
|
|
1158
1158
|
rescue OpenapiClient::ApiError => e
|
|
1159
|
-
puts "Error when calling Class20230301Api->
|
|
1159
|
+
puts "Error when calling Class20230301Api->xhr_time_off_balances20230301: #{e}"
|
|
1160
1160
|
end
|
|
1161
1161
|
```
|
|
1162
1162
|
|
|
1163
|
-
#### Using the
|
|
1163
|
+
#### Using the xhr_time_off_balances20230301_with_http_info variant
|
|
1164
1164
|
|
|
1165
1165
|
This returns an Array which contains the response data, status code and headers.
|
|
1166
1166
|
|
|
1167
|
-
> <Array(<Array<
|
|
1167
|
+
> <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> xhr_time_off_balances20230301_with_http_info
|
|
1168
1168
|
|
|
1169
1169
|
```ruby
|
|
1170
1170
|
begin
|
|
1171
|
-
# Time off
|
|
1172
|
-
data, status_code, headers = api_instance.
|
|
1171
|
+
# Time off balances
|
|
1172
|
+
data, status_code, headers = api_instance.xhr_time_off_balances20230301_with_http_info
|
|
1173
1173
|
p status_code # => 2xx
|
|
1174
1174
|
p headers # => { ... }
|
|
1175
|
-
p data # => <Array<
|
|
1175
|
+
p data # => <Array<TimeOffBalanceResponse>>
|
|
1176
1176
|
rescue OpenapiClient::ApiError => e
|
|
1177
|
-
puts "Error when calling Class20230301Api->
|
|
1177
|
+
puts "Error when calling Class20230301Api->xhr_time_off_balances20230301_with_http_info: #{e}"
|
|
1178
1178
|
end
|
|
1179
1179
|
```
|
|
1180
1180
|
|
|
@@ -1184,7 +1184,7 @@ This endpoint does not need any parameter.
|
|
|
1184
1184
|
|
|
1185
1185
|
### Return type
|
|
1186
1186
|
|
|
1187
|
-
[**Array<
|
|
1187
|
+
[**Array<TimeOffBalanceResponse>**](TimeOffBalanceResponse.md)
|
|
1188
1188
|
|
|
1189
1189
|
### Authorization
|
|
1190
1190
|
|
|
@@ -1196,13 +1196,13 @@ This endpoint does not need any parameter.
|
|
|
1196
1196
|
- **Accept**: application/json
|
|
1197
1197
|
|
|
1198
1198
|
|
|
1199
|
-
##
|
|
1199
|
+
## xhr_time_off_entries20230301
|
|
1200
1200
|
|
|
1201
|
-
> <Array<
|
|
1201
|
+
> <Array<TimeOffEntryResponse>> xhr_time_off_entries20230301
|
|
1202
1202
|
|
|
1203
|
-
|
|
1203
|
+
Time off entries
|
|
1204
1204
|
|
|
1205
|
-
Retrieve
|
|
1205
|
+
Retrieve time off / absence entries
|
|
1206
1206
|
|
|
1207
1207
|
### Examples
|
|
1208
1208
|
|
|
@@ -1220,29 +1220,29 @@ end
|
|
|
1220
1220
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
1221
1221
|
|
|
1222
1222
|
begin
|
|
1223
|
-
#
|
|
1224
|
-
result = api_instance.
|
|
1223
|
+
# Time off entries
|
|
1224
|
+
result = api_instance.xhr_time_off_entries20230301
|
|
1225
1225
|
p result
|
|
1226
1226
|
rescue OpenapiClient::ApiError => e
|
|
1227
|
-
puts "Error when calling Class20230301Api->
|
|
1227
|
+
puts "Error when calling Class20230301Api->xhr_time_off_entries20230301: #{e}"
|
|
1228
1228
|
end
|
|
1229
1229
|
```
|
|
1230
1230
|
|
|
1231
|
-
#### Using the
|
|
1231
|
+
#### Using the xhr_time_off_entries20230301_with_http_info variant
|
|
1232
1232
|
|
|
1233
1233
|
This returns an Array which contains the response data, status code and headers.
|
|
1234
1234
|
|
|
1235
|
-
> <Array(<Array<
|
|
1235
|
+
> <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> xhr_time_off_entries20230301_with_http_info
|
|
1236
1236
|
|
|
1237
1237
|
```ruby
|
|
1238
1238
|
begin
|
|
1239
|
-
#
|
|
1240
|
-
data, status_code, headers = api_instance.
|
|
1239
|
+
# Time off entries
|
|
1240
|
+
data, status_code, headers = api_instance.xhr_time_off_entries20230301_with_http_info
|
|
1241
1241
|
p status_code # => 2xx
|
|
1242
1242
|
p headers # => { ... }
|
|
1243
|
-
p data # => <Array<
|
|
1243
|
+
p data # => <Array<TimeOffEntryResponse>>
|
|
1244
1244
|
rescue OpenapiClient::ApiError => e
|
|
1245
|
-
puts "Error when calling Class20230301Api->
|
|
1245
|
+
puts "Error when calling Class20230301Api->xhr_time_off_entries20230301_with_http_info: #{e}"
|
|
1246
1246
|
end
|
|
1247
1247
|
```
|
|
1248
1248
|
|
|
@@ -1252,7 +1252,7 @@ This endpoint does not need any parameter.
|
|
|
1252
1252
|
|
|
1253
1253
|
### Return type
|
|
1254
1254
|
|
|
1255
|
-
[**Array<
|
|
1255
|
+
[**Array<TimeOffEntryResponse>**](TimeOffEntryResponse.md)
|
|
1256
1256
|
|
|
1257
1257
|
### Authorization
|
|
1258
1258
|
|
|
@@ -1264,13 +1264,13 @@ This endpoint does not need any parameter.
|
|
|
1264
1264
|
- **Accept**: application/json
|
|
1265
1265
|
|
|
1266
1266
|
|
|
1267
|
-
##
|
|
1267
|
+
## xhr_timesheets20230301
|
|
1268
1268
|
|
|
1269
|
-
> <Array<
|
|
1269
|
+
> <Array<TimesheetResponse>> xhr_timesheets20230301
|
|
1270
1270
|
|
|
1271
|
-
|
|
1271
|
+
Timesheets
|
|
1272
1272
|
|
|
1273
|
-
|
|
1273
|
+
Retrieve Timesheets
|
|
1274
1274
|
|
|
1275
1275
|
### Examples
|
|
1276
1276
|
|
|
@@ -1288,29 +1288,29 @@ end
|
|
|
1288
1288
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
1289
1289
|
|
|
1290
1290
|
begin
|
|
1291
|
-
#
|
|
1292
|
-
result = api_instance.
|
|
1291
|
+
# Timesheets
|
|
1292
|
+
result = api_instance.xhr_timesheets20230301
|
|
1293
1293
|
p result
|
|
1294
1294
|
rescue OpenapiClient::ApiError => e
|
|
1295
|
-
puts "Error when calling Class20230301Api->
|
|
1295
|
+
puts "Error when calling Class20230301Api->xhr_timesheets20230301: #{e}"
|
|
1296
1296
|
end
|
|
1297
1297
|
```
|
|
1298
1298
|
|
|
1299
|
-
#### Using the
|
|
1299
|
+
#### Using the xhr_timesheets20230301_with_http_info variant
|
|
1300
1300
|
|
|
1301
1301
|
This returns an Array which contains the response data, status code and headers.
|
|
1302
1302
|
|
|
1303
|
-
> <Array(<Array<
|
|
1303
|
+
> <Array(<Array<TimesheetResponse>>, Integer, Hash)> xhr_timesheets20230301_with_http_info
|
|
1304
1304
|
|
|
1305
1305
|
```ruby
|
|
1306
1306
|
begin
|
|
1307
|
-
#
|
|
1308
|
-
data, status_code, headers = api_instance.
|
|
1307
|
+
# Timesheets
|
|
1308
|
+
data, status_code, headers = api_instance.xhr_timesheets20230301_with_http_info
|
|
1309
1309
|
p status_code # => 2xx
|
|
1310
1310
|
p headers # => { ... }
|
|
1311
|
-
p data # => <Array<
|
|
1311
|
+
p data # => <Array<TimesheetResponse>>
|
|
1312
1312
|
rescue OpenapiClient::ApiError => e
|
|
1313
|
-
puts "Error when calling Class20230301Api->
|
|
1313
|
+
puts "Error when calling Class20230301Api->xhr_timesheets20230301_with_http_info: #{e}"
|
|
1314
1314
|
end
|
|
1315
1315
|
```
|
|
1316
1316
|
|
|
@@ -1320,7 +1320,7 @@ This endpoint does not need any parameter.
|
|
|
1320
1320
|
|
|
1321
1321
|
### Return type
|
|
1322
1322
|
|
|
1323
|
-
[**Array<
|
|
1323
|
+
[**Array<TimesheetResponse>**](TimesheetResponse.md)
|
|
1324
1324
|
|
|
1325
1325
|
### Authorization
|
|
1326
1326
|
|
|
@@ -1332,13 +1332,13 @@ This endpoint does not need any parameter.
|
|
|
1332
1332
|
- **Accept**: application/json
|
|
1333
1333
|
|
|
1334
1334
|
|
|
1335
|
-
##
|
|
1335
|
+
## xhr_work_locations20230301
|
|
1336
1336
|
|
|
1337
|
-
> <
|
|
1337
|
+
> <Array<LocationResponse>> xhr_work_locations20230301
|
|
1338
1338
|
|
|
1339
|
-
|
|
1339
|
+
Work locations
|
|
1340
1340
|
|
|
1341
|
-
|
|
1341
|
+
The Location object is used to represent an address that can be associated with an employee
|
|
1342
1342
|
|
|
1343
1343
|
### Examples
|
|
1344
1344
|
|
|
@@ -1356,29 +1356,29 @@ end
|
|
|
1356
1356
|
api_instance = OpenapiClient::Class20230301Api.new
|
|
1357
1357
|
|
|
1358
1358
|
begin
|
|
1359
|
-
#
|
|
1360
|
-
result = api_instance.
|
|
1359
|
+
# Work locations
|
|
1360
|
+
result = api_instance.xhr_work_locations20230301
|
|
1361
1361
|
p result
|
|
1362
1362
|
rescue OpenapiClient::ApiError => e
|
|
1363
|
-
puts "Error when calling Class20230301Api->
|
|
1363
|
+
puts "Error when calling Class20230301Api->xhr_work_locations20230301: #{e}"
|
|
1364
1364
|
end
|
|
1365
1365
|
```
|
|
1366
1366
|
|
|
1367
|
-
#### Using the
|
|
1367
|
+
#### Using the xhr_work_locations20230301_with_http_info variant
|
|
1368
1368
|
|
|
1369
1369
|
This returns an Array which contains the response data, status code and headers.
|
|
1370
1370
|
|
|
1371
|
-
> <Array(<
|
|
1371
|
+
> <Array(<Array<LocationResponse>>, Integer, Hash)> xhr_work_locations20230301_with_http_info
|
|
1372
1372
|
|
|
1373
1373
|
```ruby
|
|
1374
1374
|
begin
|
|
1375
|
-
#
|
|
1376
|
-
data, status_code, headers = api_instance.
|
|
1375
|
+
# Work locations
|
|
1376
|
+
data, status_code, headers = api_instance.xhr_work_locations20230301_with_http_info
|
|
1377
1377
|
p status_code # => 2xx
|
|
1378
1378
|
p headers # => { ... }
|
|
1379
|
-
p data # => <
|
|
1379
|
+
p data # => <Array<LocationResponse>>
|
|
1380
1380
|
rescue OpenapiClient::ApiError => e
|
|
1381
|
-
puts "Error when calling Class20230301Api->
|
|
1381
|
+
puts "Error when calling Class20230301Api->xhr_work_locations20230301_with_http_info: #{e}"
|
|
1382
1382
|
end
|
|
1383
1383
|
```
|
|
1384
1384
|
|
|
@@ -1388,7 +1388,7 @@ This endpoint does not need any parameter.
|
|
|
1388
1388
|
|
|
1389
1389
|
### Return type
|
|
1390
1390
|
|
|
1391
|
-
[**
|
|
1391
|
+
[**Array<LocationResponse>**](LocationResponse.md)
|
|
1392
1392
|
|
|
1393
1393
|
### Authorization
|
|
1394
1394
|
|