affixapi 1.1.45 → 1.1.47

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +31 -49
  4. data/docs/Class20230301Api.md +102 -726
  5. data/docs/CoreApi.md +1 -1
  6. data/docs/{DeveloperApi.md → XHRVerticallyIntegratedApi.md} +111 -111
  7. data/lib/openapi_client/api/class20230301_api.rb +82 -603
  8. data/lib/openapi_client/api/core_api.rb +3 -3
  9. data/lib/openapi_client/api/management_api.rb +1 -1
  10. data/lib/openapi_client/api/{developer_api.rb → xhr_vertically_integrated_api.rb} +83 -83
  11. data/lib/openapi_client/api_client.rb +1 -1
  12. data/lib/openapi_client/api_error.rb +1 -1
  13. data/lib/openapi_client/configuration.rb +1 -1
  14. data/lib/openapi_client/models/address_no_non_null_request.rb +1 -1
  15. data/lib/openapi_client/models/address_response.rb +1 -1
  16. data/lib/openapi_client/models/client_request.rb +1 -1
  17. data/lib/openapi_client/models/client_response.rb +1 -1
  18. data/lib/openapi_client/models/company_response.rb +1 -1
  19. data/lib/openapi_client/models/create_employee_request.rb +1 -1
  20. data/lib/openapi_client/models/create_employee_request_bank_account.rb +1 -1
  21. data/lib/openapi_client/models/create_employee_request_manager.rb +1 -1
  22. data/lib/openapi_client/models/currency_request.rb +1 -1
  23. data/lib/openapi_client/models/currency_response.rb +1 -1
  24. data/lib/openapi_client/models/disconnect_response.rb +1 -1
  25. data/lib/openapi_client/models/employee_response.rb +1 -1
  26. data/lib/openapi_client/models/employment_no_null_enum_request.rb +1 -1
  27. data/lib/openapi_client/models/employment_response.rb +1 -1
  28. data/lib/openapi_client/models/group_no_null_enum_request.rb +1 -1
  29. data/lib/openapi_client/models/group_response.rb +1 -1
  30. data/lib/openapi_client/models/id_and_message_response.rb +1 -1
  31. data/lib/openapi_client/models/identity_response.rb +1 -1
  32. data/lib/openapi_client/models/inline_response400.rb +1 -1
  33. data/lib/openapi_client/models/inline_response401.rb +1 -1
  34. data/lib/openapi_client/models/inline_response409.rb +1 -1
  35. data/lib/openapi_client/models/introspect_response.rb +1 -1
  36. data/lib/openapi_client/models/location_no_non_null_request.rb +1 -1
  37. data/lib/openapi_client/models/location_response.rb +1 -1
  38. data/lib/openapi_client/models/message_response.rb +1 -1
  39. data/lib/openapi_client/models/mode_request.rb +2 -2
  40. data/lib/openapi_client/models/mode_response.rb +2 -2
  41. data/lib/openapi_client/models/payrun_response.rb +1 -1
  42. data/lib/openapi_client/models/payslip_response.rb +1 -1
  43. data/lib/openapi_client/models/payslip_response_contributions.rb +1 -1
  44. data/lib/openapi_client/models/payslip_response_deductions.rb +1 -1
  45. data/lib/openapi_client/models/payslip_response_earnings.rb +1 -1
  46. data/lib/openapi_client/models/payslip_response_taxes.rb +1 -1
  47. data/lib/openapi_client/models/provider_request.rb +1 -1
  48. data/lib/openapi_client/models/provider_response.rb +1 -1
  49. data/lib/openapi_client/models/scopes_request.rb +12 -12
  50. data/lib/openapi_client/models/scopes_response.rb +12 -12
  51. data/lib/openapi_client/models/time_off_balance_response.rb +1 -1
  52. data/lib/openapi_client/models/time_off_entry_response.rb +1 -1
  53. data/lib/openapi_client/models/timesheet_response.rb +1 -1
  54. data/lib/openapi_client/models/token_request.rb +1 -1
  55. data/lib/openapi_client/models/token_response.rb +1 -1
  56. data/lib/openapi_client/version.rb +2 -2
  57. data/lib/openapi_client.rb +2 -3
  58. data/spec/api/class20230301_api_spec.rb +23 -123
  59. data/spec/api/core_api_spec.rb +2 -2
  60. data/spec/api/management_api_spec.rb +1 -1
  61. data/spec/api/xhr_vertically_integrated_api_spec.rb +160 -0
  62. data/spec/api_client_spec.rb +1 -1
  63. data/spec/configuration_spec.rb +1 -1
  64. data/spec/models/address_no_non_null_request_spec.rb +1 -1
  65. data/spec/models/address_response_spec.rb +1 -1
  66. data/spec/models/client_request_spec.rb +1 -1
  67. data/spec/models/client_response_spec.rb +1 -1
  68. data/spec/models/company_response_spec.rb +1 -1
  69. data/spec/models/create_employee_request_bank_account_spec.rb +1 -1
  70. data/spec/models/create_employee_request_manager_spec.rb +1 -1
  71. data/spec/models/create_employee_request_spec.rb +1 -1
  72. data/spec/models/currency_request_spec.rb +1 -1
  73. data/spec/models/currency_response_spec.rb +1 -1
  74. data/spec/models/disconnect_response_spec.rb +1 -1
  75. data/spec/models/employee_response_spec.rb +1 -1
  76. data/spec/models/employment_no_null_enum_request_spec.rb +1 -1
  77. data/spec/models/employment_response_spec.rb +1 -1
  78. data/spec/models/group_no_null_enum_request_spec.rb +1 -1
  79. data/spec/models/group_response_spec.rb +1 -1
  80. data/spec/models/id_and_message_response_spec.rb +1 -1
  81. data/spec/models/identity_response_spec.rb +1 -1
  82. data/spec/models/inline_response400_spec.rb +1 -1
  83. data/spec/models/inline_response401_spec.rb +1 -1
  84. data/spec/models/inline_response409_spec.rb +1 -1
  85. data/spec/models/introspect_response_spec.rb +1 -1
  86. data/spec/models/location_no_non_null_request_spec.rb +1 -1
  87. data/spec/models/location_response_spec.rb +1 -1
  88. data/spec/models/message_response_spec.rb +1 -1
  89. data/spec/models/mode_request_spec.rb +1 -1
  90. data/spec/models/mode_response_spec.rb +1 -1
  91. data/spec/models/payrun_response_spec.rb +1 -1
  92. data/spec/models/payslip_response_contributions_spec.rb +1 -1
  93. data/spec/models/payslip_response_deductions_spec.rb +1 -1
  94. data/spec/models/payslip_response_earnings_spec.rb +1 -1
  95. data/spec/models/payslip_response_spec.rb +1 -1
  96. data/spec/models/payslip_response_taxes_spec.rb +1 -1
  97. data/spec/models/provider_request_spec.rb +1 -1
  98. data/spec/models/provider_response_spec.rb +1 -1
  99. data/spec/models/scopes_request_spec.rb +1 -1
  100. data/spec/models/scopes_response_spec.rb +1 -1
  101. data/spec/models/time_off_balance_response_spec.rb +1 -1
  102. data/spec/models/time_off_entry_response_spec.rb +1 -1
  103. data/spec/models/timesheet_response_spec.rb +1 -1
  104. data/spec/models/token_request_spec.rb +1 -1
  105. data/spec/models/token_response_spec.rb +1 -1
  106. data/spec/spec_helper.rb +1 -1
  107. metadata +6 -10
  108. data/docs/OfficialApi.md +0 -631
  109. data/lib/openapi_client/api/official_api.rb +0 -543
  110. data/spec/api/developer_api_spec.rb +0 -160
  111. data/spec/api/official_api_spec.rb +0 -135
@@ -4,31 +4,22 @@ 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
- | [**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
7
+ | [**xhr_companies20230301**](Class20230301Api.md#xhr_companies20230301) | **GET** /2023-03-01/xhr/company | Company |
8
+ | [**xhr_create_employee20230301**](Class20230301Api.md#xhr_create_employee20230301) | **POST** /2023-03-01/xhr/employee | Create employee |
9
+ | [**xhr_employees20230301**](Class20230301Api.md#xhr_employees20230301) | **GET** /2023-03-01/xhr/employees | Employees |
10
+ | [**xhr_groups20230301**](Class20230301Api.md#xhr_groups20230301) | **GET** /2023-03-01/xhr/groups | Groups |
11
+ | [**xhr_identity20230301**](Class20230301Api.md#xhr_identity20230301) | **GET** /2023-03-01/xhr/identity | Identity |
12
+ | [**xhr_payruns20230301**](Class20230301Api.md#xhr_payruns20230301) | **GET** /2023-03-01/xhr/payruns | Payruns |
13
+ | [**xhr_payslips20230301**](Class20230301Api.md#xhr_payslips20230301) | **GET** /2023-03-01/xhr/payruns/{payrun_id} | Payslips |
14
+ | [**xhr_time_off_balances20230301**](Class20230301Api.md#xhr_time_off_balances20230301) | **GET** /2023-03-01/xhr/time-off-balances | Time off balances |
15
+ | [**xhr_time_off_entries20230301**](Class20230301Api.md#xhr_time_off_entries20230301) | **GET** /2023-03-01/xhr/time-off-entries | Time off entries |
16
+ | [**xhr_timesheets20230301**](Class20230301Api.md#xhr_timesheets20230301) | **GET** /2023-03-01/xhr/timesheets | Timesheets |
17
+ | [**xhr_work_locations20230301**](Class20230301Api.md#xhr_work_locations20230301) | **GET** /2023-03-01/xhr/work-locations | Work locations |
18
+
19
+
20
+ ## xhr_companies20230301
21
+
22
+ > <Array<CompanyResponse>> xhr_companies20230301
32
23
 
33
24
  Company
34
25
 
@@ -51,28 +42,28 @@ api_instance = OpenapiClient::Class20230301Api.new
51
42
 
52
43
  begin
53
44
  # Company
54
- result = api_instance.developer_companies20230301
45
+ result = api_instance.xhr_companies20230301
55
46
  p result
56
47
  rescue OpenapiClient::ApiError => e
57
- puts "Error when calling Class20230301Api->developer_companies20230301: #{e}"
48
+ puts "Error when calling Class20230301Api->xhr_companies20230301: #{e}"
58
49
  end
59
50
  ```
60
51
 
61
- #### Using the developer_companies20230301_with_http_info variant
52
+ #### Using the xhr_companies20230301_with_http_info variant
62
53
 
63
54
  This returns an Array which contains the response data, status code and headers.
64
55
 
65
- > <Array(<Array<CompanyResponse>>, Integer, Hash)> developer_companies20230301_with_http_info
56
+ > <Array(<Array<CompanyResponse>>, Integer, Hash)> xhr_companies20230301_with_http_info
66
57
 
67
58
  ```ruby
68
59
  begin
69
60
  # Company
70
- data, status_code, headers = api_instance.developer_companies20230301_with_http_info
61
+ data, status_code, headers = api_instance.xhr_companies20230301_with_http_info
71
62
  p status_code # => 2xx
72
63
  p headers # => { ... }
73
64
  p data # => <Array<CompanyResponse>>
74
65
  rescue OpenapiClient::ApiError => e
75
- puts "Error when calling Class20230301Api->developer_companies20230301_with_http_info: #{e}"
66
+ puts "Error when calling Class20230301Api->xhr_companies20230301_with_http_info: #{e}"
76
67
  end
77
68
  ```
78
69
 
@@ -94,9 +85,9 @@ This endpoint does not need any parameter.
94
85
  - **Accept**: application/json
95
86
 
96
87
 
97
- ## developer_create_employee20230301
88
+ ## xhr_create_employee20230301
98
89
 
99
- > <EmployeeResponse> developer_create_employee20230301(create_employee_request)
90
+ > <EmployeeResponse> xhr_create_employee20230301(create_employee_request)
100
91
 
101
92
  Create employee
102
93
 
@@ -120,28 +111,28 @@ create_employee_request = OpenapiClient::CreateEmployeeRequest.new({first_name:
120
111
 
121
112
  begin
122
113
  # Create employee
123
- result = api_instance.developer_create_employee20230301(create_employee_request)
114
+ result = api_instance.xhr_create_employee20230301(create_employee_request)
124
115
  p result
125
116
  rescue OpenapiClient::ApiError => e
126
- puts "Error when calling Class20230301Api->developer_create_employee20230301: #{e}"
117
+ puts "Error when calling Class20230301Api->xhr_create_employee20230301: #{e}"
127
118
  end
128
119
  ```
129
120
 
130
- #### Using the developer_create_employee20230301_with_http_info variant
121
+ #### Using the xhr_create_employee20230301_with_http_info variant
131
122
 
132
123
  This returns an Array which contains the response data, status code and headers.
133
124
 
134
- > <Array(<EmployeeResponse>, Integer, Hash)> developer_create_employee20230301_with_http_info(create_employee_request)
125
+ > <Array(<EmployeeResponse>, Integer, Hash)> xhr_create_employee20230301_with_http_info(create_employee_request)
135
126
 
136
127
  ```ruby
137
128
  begin
138
129
  # Create employee
139
- data, status_code, headers = api_instance.developer_create_employee20230301_with_http_info(create_employee_request)
130
+ data, status_code, headers = api_instance.xhr_create_employee20230301_with_http_info(create_employee_request)
140
131
  p status_code # => 2xx
141
132
  p headers # => { ... }
142
133
  p data # => <EmployeeResponse>
143
134
  rescue OpenapiClient::ApiError => e
144
- puts "Error when calling Class20230301Api->developer_create_employee20230301_with_http_info: #{e}"
135
+ puts "Error when calling Class20230301Api->xhr_create_employee20230301_with_http_info: #{e}"
145
136
  end
146
137
  ```
147
138
 
@@ -165,9 +156,9 @@ end
165
156
  - **Accept**: application/json
166
157
 
167
158
 
168
- ## developer_employees20230301
159
+ ## xhr_employees20230301
169
160
 
170
- > <Array<EmployeeResponse>> developer_employees20230301
161
+ > <Array<EmployeeResponse>> xhr_employees20230301
171
162
 
172
163
  Employees
173
164
 
@@ -190,28 +181,28 @@ api_instance = OpenapiClient::Class20230301Api.new
190
181
 
191
182
  begin
192
183
  # Employees
193
- result = api_instance.developer_employees20230301
184
+ result = api_instance.xhr_employees20230301
194
185
  p result
195
186
  rescue OpenapiClient::ApiError => e
196
- puts "Error when calling Class20230301Api->developer_employees20230301: #{e}"
187
+ puts "Error when calling Class20230301Api->xhr_employees20230301: #{e}"
197
188
  end
198
189
  ```
199
190
 
200
- #### Using the developer_employees20230301_with_http_info variant
191
+ #### Using the xhr_employees20230301_with_http_info variant
201
192
 
202
193
  This returns an Array which contains the response data, status code and headers.
203
194
 
204
- > <Array(<Array<EmployeeResponse>>, Integer, Hash)> developer_employees20230301_with_http_info
195
+ > <Array(<Array<EmployeeResponse>>, Integer, Hash)> xhr_employees20230301_with_http_info
205
196
 
206
197
  ```ruby
207
198
  begin
208
199
  # Employees
209
- data, status_code, headers = api_instance.developer_employees20230301_with_http_info
200
+ data, status_code, headers = api_instance.xhr_employees20230301_with_http_info
210
201
  p status_code # => 2xx
211
202
  p headers # => { ... }
212
203
  p data # => <Array<EmployeeResponse>>
213
204
  rescue OpenapiClient::ApiError => e
214
- puts "Error when calling Class20230301Api->developer_employees20230301_with_http_info: #{e}"
205
+ puts "Error when calling Class20230301Api->xhr_employees20230301_with_http_info: #{e}"
215
206
  end
216
207
  ```
217
208
 
@@ -233,9 +224,9 @@ This endpoint does not need any parameter.
233
224
  - **Accept**: application/json
234
225
 
235
226
 
236
- ## developer_groups20230301
227
+ ## xhr_groups20230301
237
228
 
238
- > <Array<GroupResponse>> developer_groups20230301
229
+ > <Array<GroupResponse>> xhr_groups20230301
239
230
 
240
231
  Groups
241
232
 
@@ -258,28 +249,28 @@ api_instance = OpenapiClient::Class20230301Api.new
258
249
 
259
250
  begin
260
251
  # Groups
261
- result = api_instance.developer_groups20230301
252
+ result = api_instance.xhr_groups20230301
262
253
  p result
263
254
  rescue OpenapiClient::ApiError => e
264
- puts "Error when calling Class20230301Api->developer_groups20230301: #{e}"
255
+ puts "Error when calling Class20230301Api->xhr_groups20230301: #{e}"
265
256
  end
266
257
  ```
267
258
 
268
- #### Using the developer_groups20230301_with_http_info variant
259
+ #### Using the xhr_groups20230301_with_http_info variant
269
260
 
270
261
  This returns an Array which contains the response data, status code and headers.
271
262
 
272
- > <Array(<Array<GroupResponse>>, Integer, Hash)> developer_groups20230301_with_http_info
263
+ > <Array(<Array<GroupResponse>>, Integer, Hash)> xhr_groups20230301_with_http_info
273
264
 
274
265
  ```ruby
275
266
  begin
276
267
  # Groups
277
- data, status_code, headers = api_instance.developer_groups20230301_with_http_info
268
+ data, status_code, headers = api_instance.xhr_groups20230301_with_http_info
278
269
  p status_code # => 2xx
279
270
  p headers # => { ... }
280
271
  p data # => <Array<GroupResponse>>
281
272
  rescue OpenapiClient::ApiError => e
282
- puts "Error when calling Class20230301Api->developer_groups20230301_with_http_info: #{e}"
273
+ puts "Error when calling Class20230301Api->xhr_groups20230301_with_http_info: #{e}"
283
274
  end
284
275
  ```
285
276
 
@@ -301,9 +292,9 @@ This endpoint does not need any parameter.
301
292
  - **Accept**: application/json
302
293
 
303
294
 
304
- ## developer_identity20230301
295
+ ## xhr_identity20230301
305
296
 
306
- > <IdentityResponse> developer_identity20230301
297
+ > <IdentityResponse> xhr_identity20230301
307
298
 
308
299
  Identity
309
300
 
@@ -326,28 +317,28 @@ api_instance = OpenapiClient::Class20230301Api.new
326
317
 
327
318
  begin
328
319
  # Identity
329
- result = api_instance.developer_identity20230301
320
+ result = api_instance.xhr_identity20230301
330
321
  p result
331
322
  rescue OpenapiClient::ApiError => e
332
- puts "Error when calling Class20230301Api->developer_identity20230301: #{e}"
323
+ puts "Error when calling Class20230301Api->xhr_identity20230301: #{e}"
333
324
  end
334
325
  ```
335
326
 
336
- #### Using the developer_identity20230301_with_http_info variant
327
+ #### Using the xhr_identity20230301_with_http_info variant
337
328
 
338
329
  This returns an Array which contains the response data, status code and headers.
339
330
 
340
- > <Array(<IdentityResponse>, Integer, Hash)> developer_identity20230301_with_http_info
331
+ > <Array(<IdentityResponse>, Integer, Hash)> xhr_identity20230301_with_http_info
341
332
 
342
333
  ```ruby
343
334
  begin
344
335
  # Identity
345
- data, status_code, headers = api_instance.developer_identity20230301_with_http_info
336
+ data, status_code, headers = api_instance.xhr_identity20230301_with_http_info
346
337
  p status_code # => 2xx
347
338
  p headers # => { ... }
348
339
  p data # => <IdentityResponse>
349
340
  rescue OpenapiClient::ApiError => e
350
- puts "Error when calling Class20230301Api->developer_identity20230301_with_http_info: #{e}"
341
+ puts "Error when calling Class20230301Api->xhr_identity20230301_with_http_info: #{e}"
351
342
  end
352
343
  ```
353
344
 
@@ -369,9 +360,9 @@ This endpoint does not need any parameter.
369
360
  - **Accept**: application/json
370
361
 
371
362
 
372
- ## developer_payruns20230301
363
+ ## xhr_payruns20230301
373
364
 
374
- > <Array<PayrunResponse>> developer_payruns20230301(start_date, end_date)
365
+ > <Array<PayrunResponse>> xhr_payruns20230301(start_date, end_date)
375
366
 
376
367
  Payruns
377
368
 
@@ -396,28 +387,28 @@ end_date = Date.parse('2013-10-20') # Date | The end date of the search period
396
387
 
397
388
  begin
398
389
  # Payruns
399
- result = api_instance.developer_payruns20230301(start_date, end_date)
390
+ result = api_instance.xhr_payruns20230301(start_date, end_date)
400
391
  p result
401
392
  rescue OpenapiClient::ApiError => e
402
- puts "Error when calling Class20230301Api->developer_payruns20230301: #{e}"
393
+ puts "Error when calling Class20230301Api->xhr_payruns20230301: #{e}"
403
394
  end
404
395
  ```
405
396
 
406
- #### Using the developer_payruns20230301_with_http_info variant
397
+ #### Using the xhr_payruns20230301_with_http_info variant
407
398
 
408
399
  This returns an Array which contains the response data, status code and headers.
409
400
 
410
- > <Array(<Array<PayrunResponse>>, Integer, Hash)> developer_payruns20230301_with_http_info(start_date, end_date)
401
+ > <Array(<Array<PayrunResponse>>, Integer, Hash)> xhr_payruns20230301_with_http_info(start_date, end_date)
411
402
 
412
403
  ```ruby
413
404
  begin
414
405
  # Payruns
415
- data, status_code, headers = api_instance.developer_payruns20230301_with_http_info(start_date, end_date)
406
+ data, status_code, headers = api_instance.xhr_payruns20230301_with_http_info(start_date, end_date)
416
407
  p status_code # => 2xx
417
408
  p headers # => { ... }
418
409
  p data # => <Array<PayrunResponse>>
419
410
  rescue OpenapiClient::ApiError => e
420
- puts "Error when calling Class20230301Api->developer_payruns20230301_with_http_info: #{e}"
411
+ puts "Error when calling Class20230301Api->xhr_payruns20230301_with_http_info: #{e}"
421
412
  end
422
413
  ```
423
414
 
@@ -442,9 +433,9 @@ end
442
433
  - **Accept**: application/json
443
434
 
444
435
 
445
- ## developer_payslips20230301
436
+ ## xhr_payslips20230301
446
437
 
447
- > <Array<PayslipResponse>> developer_payslips20230301(payrun_id)
438
+ > <Array<PayslipResponse>> xhr_payslips20230301(payrun_id)
448
439
 
449
440
  Payslips
450
441
 
@@ -468,28 +459,28 @@ payrun_id = 'payrun_id_example' # String | The id of the payrun.
468
459
 
469
460
  begin
470
461
  # Payslips
471
- result = api_instance.developer_payslips20230301(payrun_id)
462
+ result = api_instance.xhr_payslips20230301(payrun_id)
472
463
  p result
473
464
  rescue OpenapiClient::ApiError => e
474
- puts "Error when calling Class20230301Api->developer_payslips20230301: #{e}"
465
+ puts "Error when calling Class20230301Api->xhr_payslips20230301: #{e}"
475
466
  end
476
467
  ```
477
468
 
478
- #### Using the developer_payslips20230301_with_http_info variant
469
+ #### Using the xhr_payslips20230301_with_http_info variant
479
470
 
480
471
  This returns an Array which contains the response data, status code and headers.
481
472
 
482
- > <Array(<Array<PayslipResponse>>, Integer, Hash)> developer_payslips20230301_with_http_info(payrun_id)
473
+ > <Array(<Array<PayslipResponse>>, Integer, Hash)> xhr_payslips20230301_with_http_info(payrun_id)
483
474
 
484
475
  ```ruby
485
476
  begin
486
477
  # Payslips
487
- data, status_code, headers = api_instance.developer_payslips20230301_with_http_info(payrun_id)
478
+ data, status_code, headers = api_instance.xhr_payslips20230301_with_http_info(payrun_id)
488
479
  p status_code # => 2xx
489
480
  p headers # => { ... }
490
481
  p data # => <Array<PayslipResponse>>
491
482
  rescue OpenapiClient::ApiError => e
492
- puts "Error when calling Class20230301Api->developer_payslips20230301_with_http_info: #{e}"
483
+ puts "Error when calling Class20230301Api->xhr_payslips20230301_with_http_info: #{e}"
493
484
  end
494
485
  ```
495
486
 
@@ -513,9 +504,9 @@ end
513
504
  - **Accept**: application/json
514
505
 
515
506
 
516
- ## developer_time_off_balances20230301
507
+ ## xhr_time_off_balances20230301
517
508
 
518
- > <Array<TimeOffBalanceResponse>> developer_time_off_balances20230301
509
+ > <Array<TimeOffBalanceResponse>> xhr_time_off_balances20230301
519
510
 
520
511
  Time off balances
521
512
 
@@ -538,28 +529,28 @@ api_instance = OpenapiClient::Class20230301Api.new
538
529
 
539
530
  begin
540
531
  # Time off balances
541
- result = api_instance.developer_time_off_balances20230301
532
+ result = api_instance.xhr_time_off_balances20230301
542
533
  p result
543
534
  rescue OpenapiClient::ApiError => e
544
- puts "Error when calling Class20230301Api->developer_time_off_balances20230301: #{e}"
535
+ puts "Error when calling Class20230301Api->xhr_time_off_balances20230301: #{e}"
545
536
  end
546
537
  ```
547
538
 
548
- #### Using the developer_time_off_balances20230301_with_http_info variant
539
+ #### Using the xhr_time_off_balances20230301_with_http_info variant
549
540
 
550
541
  This returns an Array which contains the response data, status code and headers.
551
542
 
552
- > <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> developer_time_off_balances20230301_with_http_info
543
+ > <Array(<Array<TimeOffBalanceResponse>>, Integer, Hash)> xhr_time_off_balances20230301_with_http_info
553
544
 
554
545
  ```ruby
555
546
  begin
556
547
  # Time off balances
557
- data, status_code, headers = api_instance.developer_time_off_balances20230301_with_http_info
548
+ data, status_code, headers = api_instance.xhr_time_off_balances20230301_with_http_info
558
549
  p status_code # => 2xx
559
550
  p headers # => { ... }
560
551
  p data # => <Array<TimeOffBalanceResponse>>
561
552
  rescue OpenapiClient::ApiError => e
562
- puts "Error when calling Class20230301Api->developer_time_off_balances20230301_with_http_info: #{e}"
553
+ puts "Error when calling Class20230301Api->xhr_time_off_balances20230301_with_http_info: #{e}"
563
554
  end
564
555
  ```
565
556
 
@@ -581,9 +572,9 @@ This endpoint does not need any parameter.
581
572
  - **Accept**: application/json
582
573
 
583
574
 
584
- ## developer_time_off_entries20230301
575
+ ## xhr_time_off_entries20230301
585
576
 
586
- > <Array<TimeOffEntryResponse>> developer_time_off_entries20230301
577
+ > <Array<TimeOffEntryResponse>> xhr_time_off_entries20230301
587
578
 
588
579
  Time off entries
589
580
 
@@ -606,28 +597,28 @@ api_instance = OpenapiClient::Class20230301Api.new
606
597
 
607
598
  begin
608
599
  # Time off entries
609
- result = api_instance.developer_time_off_entries20230301
600
+ result = api_instance.xhr_time_off_entries20230301
610
601
  p result
611
602
  rescue OpenapiClient::ApiError => e
612
- puts "Error when calling Class20230301Api->developer_time_off_entries20230301: #{e}"
603
+ puts "Error when calling Class20230301Api->xhr_time_off_entries20230301: #{e}"
613
604
  end
614
605
  ```
615
606
 
616
- #### Using the developer_time_off_entries20230301_with_http_info variant
607
+ #### Using the xhr_time_off_entries20230301_with_http_info variant
617
608
 
618
609
  This returns an Array which contains the response data, status code and headers.
619
610
 
620
- > <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> developer_time_off_entries20230301_with_http_info
611
+ > <Array(<Array<TimeOffEntryResponse>>, Integer, Hash)> xhr_time_off_entries20230301_with_http_info
621
612
 
622
613
  ```ruby
623
614
  begin
624
615
  # Time off entries
625
- data, status_code, headers = api_instance.developer_time_off_entries20230301_with_http_info
616
+ data, status_code, headers = api_instance.xhr_time_off_entries20230301_with_http_info
626
617
  p status_code # => 2xx
627
618
  p headers # => { ... }
628
619
  p data # => <Array<TimeOffEntryResponse>>
629
620
  rescue OpenapiClient::ApiError => e
630
- puts "Error when calling Class20230301Api->developer_time_off_entries20230301_with_http_info: #{e}"
621
+ puts "Error when calling Class20230301Api->xhr_time_off_entries20230301_with_http_info: #{e}"
631
622
  end
632
623
  ```
633
624
 
@@ -649,9 +640,9 @@ This endpoint does not need any parameter.
649
640
  - **Accept**: application/json
650
641
 
651
642
 
652
- ## developer_timesheets20230301
643
+ ## xhr_timesheets20230301
653
644
 
654
- > <Array<TimesheetResponse>> developer_timesheets20230301
645
+ > <Array<TimesheetResponse>> xhr_timesheets20230301
655
646
 
656
647
  Timesheets
657
648
 
@@ -674,28 +665,28 @@ api_instance = OpenapiClient::Class20230301Api.new
674
665
 
675
666
  begin
676
667
  # Timesheets
677
- result = api_instance.developer_timesheets20230301
668
+ result = api_instance.xhr_timesheets20230301
678
669
  p result
679
670
  rescue OpenapiClient::ApiError => e
680
- puts "Error when calling Class20230301Api->developer_timesheets20230301: #{e}"
671
+ puts "Error when calling Class20230301Api->xhr_timesheets20230301: #{e}"
681
672
  end
682
673
  ```
683
674
 
684
- #### Using the developer_timesheets20230301_with_http_info variant
675
+ #### Using the xhr_timesheets20230301_with_http_info variant
685
676
 
686
677
  This returns an Array which contains the response data, status code and headers.
687
678
 
688
- > <Array(<Array<TimesheetResponse>>, Integer, Hash)> developer_timesheets20230301_with_http_info
679
+ > <Array(<Array<TimesheetResponse>>, Integer, Hash)> xhr_timesheets20230301_with_http_info
689
680
 
690
681
  ```ruby
691
682
  begin
692
683
  # Timesheets
693
- data, status_code, headers = api_instance.developer_timesheets20230301_with_http_info
684
+ data, status_code, headers = api_instance.xhr_timesheets20230301_with_http_info
694
685
  p status_code # => 2xx
695
686
  p headers # => { ... }
696
687
  p data # => <Array<TimesheetResponse>>
697
688
  rescue OpenapiClient::ApiError => e
698
- puts "Error when calling Class20230301Api->developer_timesheets20230301_with_http_info: #{e}"
689
+ puts "Error when calling Class20230301Api->xhr_timesheets20230301_with_http_info: #{e}"
699
690
  end
700
691
  ```
701
692
 
@@ -717,9 +708,9 @@ This endpoint does not need any parameter.
717
708
  - **Accept**: application/json
718
709
 
719
710
 
720
- ## developer_work_locations20230301
711
+ ## xhr_work_locations20230301
721
712
 
722
- > <Array<LocationResponse>> developer_work_locations20230301
713
+ > <Array<LocationResponse>> xhr_work_locations20230301
723
714
 
724
715
  Work locations
725
716
 
@@ -742,28 +733,28 @@ api_instance = OpenapiClient::Class20230301Api.new
742
733
 
743
734
  begin
744
735
  # Work locations
745
- result = api_instance.developer_work_locations20230301
736
+ result = api_instance.xhr_work_locations20230301
746
737
  p result
747
738
  rescue OpenapiClient::ApiError => e
748
- puts "Error when calling Class20230301Api->developer_work_locations20230301: #{e}"
739
+ puts "Error when calling Class20230301Api->xhr_work_locations20230301: #{e}"
749
740
  end
750
741
  ```
751
742
 
752
- #### Using the developer_work_locations20230301_with_http_info variant
743
+ #### Using the xhr_work_locations20230301_with_http_info variant
753
744
 
754
745
  This returns an Array which contains the response data, status code and headers.
755
746
 
756
- > <Array(<Array<LocationResponse>>, Integer, Hash)> developer_work_locations20230301_with_http_info
747
+ > <Array(<Array<LocationResponse>>, Integer, Hash)> xhr_work_locations20230301_with_http_info
757
748
 
758
749
  ```ruby
759
750
  begin
760
751
  # Work locations
761
- data, status_code, headers = api_instance.developer_work_locations20230301_with_http_info
752
+ data, status_code, headers = api_instance.xhr_work_locations20230301_with_http_info
762
753
  p status_code # => 2xx
763
754
  p headers # => { ... }
764
755
  p data # => <Array<LocationResponse>>
765
756
  rescue OpenapiClient::ApiError => e
766
- puts "Error when calling Class20230301Api->developer_work_locations20230301_with_http_info: #{e}"
757
+ puts "Error when calling Class20230301Api->xhr_work_locations20230301_with_http_info: #{e}"
767
758
  end
768
759
  ```
769
760
 
@@ -784,618 +775,3 @@ This endpoint does not need any parameter.
784
775
  - **Content-Type**: Not defined
785
776
  - **Accept**: application/json
786
777
 
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&lt;CompanyResponse&gt;**](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&lt;EmployeeResponse&gt;**](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&lt;GroupResponse&gt;**](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&lt;TimeOffBalanceResponse&gt;**](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&lt;TimeOffEntryResponse&gt;**](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&lt;TimesheetResponse&gt;**](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&lt;LocationResponse&gt;**](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
-