affixapi 1.1.44 → 1.1.46
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +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
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Affix API
|
3
3
|
|
4
|
-
#The affixapi.com API documentation. # Introduction Affix API is an OAuth 2.1 application that allows developers to access customer data, without developers needing to manage or maintain integrations; or collect login credentials or API keys from users for these third party systems. # OAuth 2.1 Affix API follows the [OAuth 2.1 spec](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-08). As an OAuth application, Affix API handles not only both the collection of sensitive user credentials or API keys, but also builds and maintains the integrations with the providers, so you don't have to. # How to obtain an access token in order to get started, you must: - register a `client_id` - direct your user to the sign in flow (`https://connect.affixapi.com` [with the appropriate query parameters](https://github.com/affixapi/starter-kit/tree/master/connect)) - capture `authorization_code` we will send to your redirect URI after the sign in flow is complete and exchange that `authorization_code` for a Bearer token # Sandbox keys (
|
4
|
+
#The affixapi.com API documentation. # Introduction Affix API is an OAuth 2.1 application that allows developers to access customer data, without developers needing to manage or maintain integrations; or collect login credentials or API keys from users for these third party systems. # OAuth 2.1 Affix API follows the [OAuth 2.1 spec](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-08). As an OAuth application, Affix API handles not only both the collection of sensitive user credentials or API keys, but also builds and maintains the integrations with the providers, so you don't have to. # How to obtain an access token in order to get started, you must: - register a `client_id` - direct your user to the sign in flow (`https://connect.affixapi.com` [with the appropriate query parameters](https://github.com/affixapi/starter-kit/tree/master/connect)) - capture `authorization_code` we will send to your redirect URI after the sign in flow is complete and exchange that `authorization_code` for a Bearer token # Sandbox keys (xhr mode) ### dev ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6ImQ1OTZhMmYzLWYzNzktNGE1ZC1hMmRhLTk4OWJmYWViYTg1ZCIsImlhdCI6MTcwMjkyMDkwMywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5kZXYuZW5naW5lZXJpbmcuYWZmaXhhcGkuY29tIiwic3ViIjoiZGV2ZWxvcGVyIiwiYXVkIjoiM0ZEQUVERjktMURDQTRGNTQtODc5NDlGNkEtNDEwMjc2NDMifQ.VLWYjCQvBS0C3ZA6_J3-U-idZj5EYI2IlDdTjAWBxSIHGufp6cqaVodKsF2BeIqcIeB3P0lW-KL9mY3xGd7ckQ ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6ImQ1OTZhMmYzLWYzNzktNGE1ZC1hMmRhLTk4OWJmYWViYTg1ZCIsImlhdCI6MTcwMjkyMDkwMywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5kZXYuZW5naW5lZXJpbmcuYWZmaXhhcGkuY29tIiwic3ViIjoiZGV2ZWxvcGVyIiwiYXVkIjoiM0ZEQUVERjktMURDQTRGNTQtODc5NDlGNkEtNDEwMjc2NDMifQ.VLWYjCQvBS0C3ZA6_J3-U-idZj5EYI2IlDdTjAWBxSIHGufp6cqaVodKsF2BeIqcIeB3P0lW-KL9mY3xGd7ckQ' \\ 'https://dev.api.affixapi.com/2023-03-01/xhr/employees' ``` ### prod ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6IjI5YjFjYTg4LWNlNjktNDgyZC1iNGZjLTkzMWMzZmJkYWM4ZSIsImlhdCI6MTcwMjkyMTA4MywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5wcm9kLmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6ImRldmVsb3BlciIsImF1ZCI6IjA4QkIwODFFLUQ5QUI0RDE0LThERjk5MjMzLTY2NjE1Q0U5In0.2zdpFAmiyYiYk6MOcbXNUwwR4M1Fextnaac340x54AidiWXCyw-u9KeavbqfYF6q8a9kcDLrxhJ8Wc_3tIzuVw ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6IjI5YjFjYTg4LWNlNjktNDgyZC1iNGZjLTkzMWMzZmJkYWM4ZSIsImlhdCI6MTcwMjkyMTA4MywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5wcm9kLmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6ImRldmVsb3BlciIsImF1ZCI6IjA4QkIwODFFLUQ5QUI0RDE0LThERjk5MjMzLTY2NjE1Q0U5In0.2zdpFAmiyYiYk6MOcbXNUwwR4M1Fextnaac340x54AidiWXCyw-u9KeavbqfYF6q8a9kcDLrxhJ8Wc_3tIzuVw' \\ 'https://api.affixapi.com/2023-03-01/xhr/employees' ``` # Compression We support `brotli`, `gzip`, and `deflate` compression algorithms. To enable, pass the `Accept-Encoding` header with one or all of the values: `br`, `gzip`, `deflate`, or `identity` (no compression) In the response, you will receive the `Content-Encoding` response header indicating the compression algorithm used in the data payload to enable you to decompress the result. If the `Accept-Encoding: identity` header was passed, no `Content-Encoding` response header is sent back, as no compression algorithm was used. # Webhooks An exciting feature for HR/Payroll modes are webhooks. If enabled, your `webhook_uri` is set on your `client_id` for the respective environment: `dev | prod` Webhooks are configured to make live requests to the underlying integration 1x/hr, and if a difference is detected since the last request, we will send a request to your `webhook_uri` with this shape: ``` { added: <api.v20230301.Employees>[ <api.v20230301.Employee>{ ..., date_of_birth: '2010-08-06', display_full_name: 'Daija Rogahn', employee_number: '57993', employment_status: 'pending', employment_type: 'other', employments: [ { currency: 'eur', effective_date: '2022-02-25', employment_type: 'other', job_title: 'Dynamic Implementation Manager', pay_frequency: 'semimonthly', pay_period: 'YEAR', pay_rate: 96000, }, ], first_name: 'Daija', ... } ], removed: [], updated: [ <api.v20230301.Employee>{ ..., date_of_birth: '2009-11-09', display_full_name: 'Lourdes Stiedemann', employee_number: '63189', employment_status: 'leave', employment_type: 'full_time', employments: [ { currency: 'gbp', effective_date: '2023-01-16', employment_type: 'full_time', job_title: 'Forward Brand Planner', pay_frequency: 'semimonthly', pay_period: 'YEAR', pay_rate: 86000, }, ], first_name: 'Lourdes', } ] } ``` the following headers will be sent with webhook requests: ``` x-affix-api-signature: ab8474e609db95d5df3adc39ea3add7a7544bd215c5c520a30a650ae93a2fba7 x-affix-api-origin: webhooks-employees-webhook user-agent: affixapi.com ``` Before trusting the payload, you should sign the payload and verify the signature matches the signature sent by the `affixapi.com` service. This secures that the data sent to your `webhook_uri` is from the `affixapi.com` server. The signature is created by combining the signing secret (your `client_secret`) with the body of the request sent using a standard HMAC-SHA256 keyed hash. The signature can be created via: - create an `HMAC` with your `client_secret` - update the `HMAC` with the payload - get the hex digest -> this is the signature Sample `typescript` code that follows this recipe: ``` import { createHmac } from 'crypto'; export const computeSignature = ({ str, signingSecret, }: { signingSecret: string; str: string; }): string => { const hmac = createHmac('sha256', signingSecret); hmac.update(str); const signature = hmac.digest('hex'); return signature; }; ``` While verifying the Affix API signature header should be your primary method of confirming validity, you can also whitelist our outbound webhook static IP addresses. ``` dev: - 52.210.169.82 - 52.210.38.77 - 3.248.135.204 prod: - 52.51.160.102 - 54.220.83.244 - 3.254.213.171 ``` ## Rate limits Open endpoints (not gated by an API key) (applied at endpoint level): - 15 requests every 1 minute (by IP address) - 25 requests every 5 minutes (by IP address) Gated endpoints (require an API key) (applied at endpoint level): - 40 requests every 1 minute (by IP address) - 40 requests every 5 minutes (by `client_id`) Things to keep in mind: - Open endpoints (not gated by an API key) will likely be called by your users, not you, so rate limits generally would not apply to you. - As a developer, rate limits are applied at the endpoint granularity. - For example, say the rate limits below are 10 requests per minute by ip. from that same ip, within 1 minute, you get: - 10 requests per minute on `/orders`, - another 10 requests per minute on `/items`, - and another 10 requests per minute on `/identity`, - for a total of 30 requests per minute.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 2023-03-01
|
7
7
|
Contact: developers@affixapi.com
|
@@ -23,8 +23,8 @@ module OpenapiClient
|
|
23
23
|
# Retrieve company information
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [Array<CompanyResponse>]
|
26
|
-
def
|
27
|
-
data, _status_code, _headers =
|
26
|
+
def official_companies20230301(opts = {})
|
27
|
+
data, _status_code, _headers = official_companies20230301_with_http_info(opts)
|
28
28
|
data
|
29
29
|
end
|
30
30
|
|
@@ -32,12 +32,12 @@ module OpenapiClient
|
|
32
32
|
# Retrieve company information
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(Array<CompanyResponse>, Integer, Hash)>] Array<CompanyResponse> data, response status code and response headers
|
35
|
-
def
|
35
|
+
def official_companies20230301_with_http_info(opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
37
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_companies20230301 ...'
|
38
38
|
end
|
39
39
|
# resource path
|
40
|
-
local_var_path = '/2023-03-01/
|
40
|
+
local_var_path = '/2023-03-01/official/company'
|
41
41
|
|
42
42
|
# query parameters
|
43
43
|
query_params = opts[:query_params] || {}
|
@@ -60,7 +60,7 @@ module OpenapiClient
|
|
60
60
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
|
-
:operation => :"Class20230301Api.
|
63
|
+
:operation => :"Class20230301Api.official_companies20230301",
|
64
64
|
:header_params => header_params,
|
65
65
|
:query_params => query_params,
|
66
66
|
:form_params => form_params,
|
@@ -71,36 +71,36 @@ module OpenapiClient
|
|
71
71
|
|
72
72
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
73
73
|
if @api_client.config.debugging
|
74
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
74
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_companies20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
75
|
end
|
76
76
|
return data, status_code, headers
|
77
77
|
end
|
78
78
|
|
79
|
-
# Create
|
79
|
+
# Create Employee
|
80
80
|
# Creates a new Employee
|
81
81
|
# @param create_employee_request [CreateEmployeeRequest]
|
82
82
|
# @param [Hash] opts the optional parameters
|
83
83
|
# @return [EmployeeResponse]
|
84
|
-
def
|
85
|
-
data, _status_code, _headers =
|
84
|
+
def official_create_employee20230301(create_employee_request, opts = {})
|
85
|
+
data, _status_code, _headers = official_create_employee20230301_with_http_info(create_employee_request, opts)
|
86
86
|
data
|
87
87
|
end
|
88
88
|
|
89
|
-
# Create
|
89
|
+
# Create Employee
|
90
90
|
# Creates a new Employee
|
91
91
|
# @param create_employee_request [CreateEmployeeRequest]
|
92
92
|
# @param [Hash] opts the optional parameters
|
93
93
|
# @return [Array<(EmployeeResponse, Integer, Hash)>] EmployeeResponse data, response status code and response headers
|
94
|
-
def
|
94
|
+
def official_create_employee20230301_with_http_info(create_employee_request, opts = {})
|
95
95
|
if @api_client.config.debugging
|
96
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
96
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_create_employee20230301 ...'
|
97
97
|
end
|
98
98
|
# verify the required parameter 'create_employee_request' is set
|
99
99
|
if @api_client.config.client_side_validation && create_employee_request.nil?
|
100
|
-
fail ArgumentError, "Missing the required parameter 'create_employee_request' when calling Class20230301Api.
|
100
|
+
fail ArgumentError, "Missing the required parameter 'create_employee_request' when calling Class20230301Api.official_create_employee20230301"
|
101
101
|
end
|
102
102
|
# resource path
|
103
|
-
local_var_path = '/2023-03-01/
|
103
|
+
local_var_path = '/2023-03-01/official/employee'
|
104
104
|
|
105
105
|
# query parameters
|
106
106
|
query_params = opts[:query_params] || {}
|
@@ -125,7 +125,7 @@ module OpenapiClient
|
|
125
125
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
126
126
|
|
127
127
|
new_options = opts.merge(
|
128
|
-
:operation => :"Class20230301Api.
|
128
|
+
:operation => :"Class20230301Api.official_create_employee20230301",
|
129
129
|
:header_params => header_params,
|
130
130
|
:query_params => query_params,
|
131
131
|
:form_params => form_params,
|
@@ -136,7 +136,7 @@ module OpenapiClient
|
|
136
136
|
|
137
137
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
138
138
|
if @api_client.config.debugging
|
139
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
139
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_create_employee20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
140
140
|
end
|
141
141
|
return data, status_code, headers
|
142
142
|
end
|
@@ -145,8 +145,8 @@ module OpenapiClient
|
|
145
145
|
# List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
146
146
|
# @param [Hash] opts the optional parameters
|
147
147
|
# @return [Array<EmployeeResponse>]
|
148
|
-
def
|
149
|
-
data, _status_code, _headers =
|
148
|
+
def official_employees20230301(opts = {})
|
149
|
+
data, _status_code, _headers = official_employees20230301_with_http_info(opts)
|
150
150
|
data
|
151
151
|
end
|
152
152
|
|
@@ -154,12 +154,12 @@ module OpenapiClient
|
|
154
154
|
# List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
155
155
|
# @param [Hash] opts the optional parameters
|
156
156
|
# @return [Array<(Array<EmployeeResponse>, Integer, Hash)>] Array<EmployeeResponse> data, response status code and response headers
|
157
|
-
def
|
157
|
+
def official_employees20230301_with_http_info(opts = {})
|
158
158
|
if @api_client.config.debugging
|
159
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
159
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_employees20230301 ...'
|
160
160
|
end
|
161
161
|
# resource path
|
162
|
-
local_var_path = '/2023-03-01/
|
162
|
+
local_var_path = '/2023-03-01/official/employees'
|
163
163
|
|
164
164
|
# query parameters
|
165
165
|
query_params = opts[:query_params] || {}
|
@@ -182,7 +182,7 @@ module OpenapiClient
|
|
182
182
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
183
183
|
|
184
184
|
new_options = opts.merge(
|
185
|
-
:operation => :"Class20230301Api.
|
185
|
+
:operation => :"Class20230301Api.official_employees20230301",
|
186
186
|
:header_params => header_params,
|
187
187
|
:query_params => query_params,
|
188
188
|
:form_params => form_params,
|
@@ -193,7 +193,7 @@ module OpenapiClient
|
|
193
193
|
|
194
194
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
195
195
|
if @api_client.config.debugging
|
196
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
196
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_employees20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
197
197
|
end
|
198
198
|
return data, status_code, headers
|
199
199
|
end
|
@@ -202,8 +202,8 @@ module OpenapiClient
|
|
202
202
|
# The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
203
203
|
# @param [Hash] opts the optional parameters
|
204
204
|
# @return [Array<GroupResponse>]
|
205
|
-
def
|
206
|
-
data, _status_code, _headers =
|
205
|
+
def official_groups20230301(opts = {})
|
206
|
+
data, _status_code, _headers = official_groups20230301_with_http_info(opts)
|
207
207
|
data
|
208
208
|
end
|
209
209
|
|
@@ -211,12 +211,12 @@ module OpenapiClient
|
|
211
211
|
# The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
212
212
|
# @param [Hash] opts the optional parameters
|
213
213
|
# @return [Array<(Array<GroupResponse>, Integer, Hash)>] Array<GroupResponse> data, response status code and response headers
|
214
|
-
def
|
214
|
+
def official_groups20230301_with_http_info(opts = {})
|
215
215
|
if @api_client.config.debugging
|
216
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
216
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_groups20230301 ...'
|
217
217
|
end
|
218
218
|
# resource path
|
219
|
-
local_var_path = '/2023-03-01/
|
219
|
+
local_var_path = '/2023-03-01/official/groups'
|
220
220
|
|
221
221
|
# query parameters
|
222
222
|
query_params = opts[:query_params] || {}
|
@@ -239,7 +239,7 @@ module OpenapiClient
|
|
239
239
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
240
240
|
|
241
241
|
new_options = opts.merge(
|
242
|
-
:operation => :"Class20230301Api.
|
242
|
+
:operation => :"Class20230301Api.official_groups20230301",
|
243
243
|
:header_params => header_params,
|
244
244
|
:query_params => query_params,
|
245
245
|
:form_params => form_params,
|
@@ -250,30 +250,30 @@ module OpenapiClient
|
|
250
250
|
|
251
251
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
252
252
|
if @api_client.config.debugging
|
253
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
253
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_groups20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
254
254
|
end
|
255
255
|
return data, status_code, headers
|
256
256
|
end
|
257
257
|
|
258
|
-
#
|
259
|
-
#
|
258
|
+
# Time off balances
|
259
|
+
# Retrieve all time off balances.
|
260
260
|
# @param [Hash] opts the optional parameters
|
261
|
-
# @return [
|
262
|
-
def
|
263
|
-
data, _status_code, _headers =
|
261
|
+
# @return [Array<TimeOffBalanceResponse>]
|
262
|
+
def official_time_off_balances20230301(opts = {})
|
263
|
+
data, _status_code, _headers = official_time_off_balances20230301_with_http_info(opts)
|
264
264
|
data
|
265
265
|
end
|
266
266
|
|
267
|
-
#
|
268
|
-
#
|
267
|
+
# Time off balances
|
268
|
+
# Retrieve all time off balances.
|
269
269
|
# @param [Hash] opts the optional parameters
|
270
|
-
# @return [Array<(
|
271
|
-
def
|
270
|
+
# @return [Array<(Array<TimeOffBalanceResponse>, Integer, Hash)>] Array<TimeOffBalanceResponse> data, response status code and response headers
|
271
|
+
def official_time_off_balances20230301_with_http_info(opts = {})
|
272
272
|
if @api_client.config.debugging
|
273
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
273
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_time_off_balances20230301 ...'
|
274
274
|
end
|
275
275
|
# resource path
|
276
|
-
local_var_path = '/2023-03-01/
|
276
|
+
local_var_path = '/2023-03-01/official/time-off-balances'
|
277
277
|
|
278
278
|
# query parameters
|
279
279
|
query_params = opts[:query_params] || {}
|
@@ -290,13 +290,13 @@ module OpenapiClient
|
|
290
290
|
post_body = opts[:debug_body]
|
291
291
|
|
292
292
|
# return_type
|
293
|
-
return_type = opts[:debug_return_type] || '
|
293
|
+
return_type = opts[:debug_return_type] || 'Array<TimeOffBalanceResponse>'
|
294
294
|
|
295
295
|
# auth_names
|
296
296
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
297
297
|
|
298
298
|
new_options = opts.merge(
|
299
|
-
:operation => :"Class20230301Api.
|
299
|
+
:operation => :"Class20230301Api.official_time_off_balances20230301",
|
300
300
|
:header_params => header_params,
|
301
301
|
:query_params => query_params,
|
302
302
|
:form_params => form_params,
|
@@ -307,47 +307,33 @@ module OpenapiClient
|
|
307
307
|
|
308
308
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
309
309
|
if @api_client.config.debugging
|
310
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
310
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_time_off_balances20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
311
311
|
end
|
312
312
|
return data, status_code, headers
|
313
313
|
end
|
314
314
|
|
315
|
-
#
|
316
|
-
#
|
317
|
-
# @param start_date [Date] The start date of the search period
|
318
|
-
# @param end_date [Date] The end date of the search period
|
315
|
+
# Time off entries
|
316
|
+
# Retrieve time off / absence entries
|
319
317
|
# @param [Hash] opts the optional parameters
|
320
|
-
# @return [Array<
|
321
|
-
def
|
322
|
-
data, _status_code, _headers =
|
318
|
+
# @return [Array<TimeOffEntryResponse>]
|
319
|
+
def official_time_off_entries20230301(opts = {})
|
320
|
+
data, _status_code, _headers = official_time_off_entries20230301_with_http_info(opts)
|
323
321
|
data
|
324
322
|
end
|
325
323
|
|
326
|
-
#
|
327
|
-
#
|
328
|
-
# @param start_date [Date] The start date of the search period
|
329
|
-
# @param end_date [Date] The end date of the search period
|
324
|
+
# Time off entries
|
325
|
+
# Retrieve time off / absence entries
|
330
326
|
# @param [Hash] opts the optional parameters
|
331
|
-
# @return [Array<(Array<
|
332
|
-
def
|
327
|
+
# @return [Array<(Array<TimeOffEntryResponse>, Integer, Hash)>] Array<TimeOffEntryResponse> data, response status code and response headers
|
328
|
+
def official_time_off_entries20230301_with_http_info(opts = {})
|
333
329
|
if @api_client.config.debugging
|
334
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
335
|
-
end
|
336
|
-
# verify the required parameter 'start_date' is set
|
337
|
-
if @api_client.config.client_side_validation && start_date.nil?
|
338
|
-
fail ArgumentError, "Missing the required parameter 'start_date' when calling Class20230301Api.developer_payruns20230301"
|
339
|
-
end
|
340
|
-
# verify the required parameter 'end_date' is set
|
341
|
-
if @api_client.config.client_side_validation && end_date.nil?
|
342
|
-
fail ArgumentError, "Missing the required parameter 'end_date' when calling Class20230301Api.developer_payruns20230301"
|
330
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_time_off_entries20230301 ...'
|
343
331
|
end
|
344
332
|
# resource path
|
345
|
-
local_var_path = '/2023-03-01/
|
333
|
+
local_var_path = '/2023-03-01/official/time-off-entries'
|
346
334
|
|
347
335
|
# query parameters
|
348
336
|
query_params = opts[:query_params] || {}
|
349
|
-
query_params[:'start_date'] = start_date
|
350
|
-
query_params[:'end_date'] = end_date
|
351
337
|
|
352
338
|
# header parameters
|
353
339
|
header_params = opts[:header_params] || {}
|
@@ -361,13 +347,13 @@ module OpenapiClient
|
|
361
347
|
post_body = opts[:debug_body]
|
362
348
|
|
363
349
|
# return_type
|
364
|
-
return_type = opts[:debug_return_type] || 'Array<
|
350
|
+
return_type = opts[:debug_return_type] || 'Array<TimeOffEntryResponse>'
|
365
351
|
|
366
352
|
# auth_names
|
367
353
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
368
354
|
|
369
355
|
new_options = opts.merge(
|
370
|
-
:operation => :"Class20230301Api.
|
356
|
+
:operation => :"Class20230301Api.official_time_off_entries20230301",
|
371
357
|
:header_params => header_params,
|
372
358
|
:query_params => query_params,
|
373
359
|
:form_params => form_params,
|
@@ -378,36 +364,30 @@ module OpenapiClient
|
|
378
364
|
|
379
365
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
380
366
|
if @api_client.config.debugging
|
381
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
367
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_time_off_entries20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
382
368
|
end
|
383
369
|
return data, status_code, headers
|
384
370
|
end
|
385
371
|
|
386
|
-
#
|
387
|
-
#
|
388
|
-
# @param payrun_id [String] The id of the payrun.
|
372
|
+
# Timesheets
|
373
|
+
# Retrieve Timesheets
|
389
374
|
# @param [Hash] opts the optional parameters
|
390
|
-
# @return [Array<
|
391
|
-
def
|
392
|
-
data, _status_code, _headers =
|
375
|
+
# @return [Array<TimesheetResponse>]
|
376
|
+
def official_timesheets20230301(opts = {})
|
377
|
+
data, _status_code, _headers = official_timesheets20230301_with_http_info(opts)
|
393
378
|
data
|
394
379
|
end
|
395
380
|
|
396
|
-
#
|
397
|
-
#
|
398
|
-
# @param payrun_id [String] The id of the payrun.
|
381
|
+
# Timesheets
|
382
|
+
# Retrieve Timesheets
|
399
383
|
# @param [Hash] opts the optional parameters
|
400
|
-
# @return [Array<(Array<
|
401
|
-
def
|
384
|
+
# @return [Array<(Array<TimesheetResponse>, Integer, Hash)>] Array<TimesheetResponse> data, response status code and response headers
|
385
|
+
def official_timesheets20230301_with_http_info(opts = {})
|
402
386
|
if @api_client.config.debugging
|
403
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
404
|
-
end
|
405
|
-
# verify the required parameter 'payrun_id' is set
|
406
|
-
if @api_client.config.client_side_validation && payrun_id.nil?
|
407
|
-
fail ArgumentError, "Missing the required parameter 'payrun_id' when calling Class20230301Api.developer_payslips20230301"
|
387
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_timesheets20230301 ...'
|
408
388
|
end
|
409
389
|
# resource path
|
410
|
-
local_var_path = '/2023-03-01/
|
390
|
+
local_var_path = '/2023-03-01/official/timesheets'
|
411
391
|
|
412
392
|
# query parameters
|
413
393
|
query_params = opts[:query_params] || {}
|
@@ -424,13 +404,13 @@ module OpenapiClient
|
|
424
404
|
post_body = opts[:debug_body]
|
425
405
|
|
426
406
|
# return_type
|
427
|
-
return_type = opts[:debug_return_type] || 'Array<
|
407
|
+
return_type = opts[:debug_return_type] || 'Array<TimesheetResponse>'
|
428
408
|
|
429
409
|
# auth_names
|
430
410
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
431
411
|
|
432
412
|
new_options = opts.merge(
|
433
|
-
:operation => :"Class20230301Api.
|
413
|
+
:operation => :"Class20230301Api.official_timesheets20230301",
|
434
414
|
:header_params => header_params,
|
435
415
|
:query_params => query_params,
|
436
416
|
:form_params => form_params,
|
@@ -441,30 +421,30 @@ module OpenapiClient
|
|
441
421
|
|
442
422
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
443
423
|
if @api_client.config.debugging
|
444
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
424
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_timesheets20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
445
425
|
end
|
446
426
|
return data, status_code, headers
|
447
427
|
end
|
448
428
|
|
449
|
-
#
|
450
|
-
#
|
429
|
+
# Work locations
|
430
|
+
# The Location object is used to represent an address that can be associated with an employee
|
451
431
|
# @param [Hash] opts the optional parameters
|
452
|
-
# @return [Array<
|
453
|
-
def
|
454
|
-
data, _status_code, _headers =
|
432
|
+
# @return [Array<LocationResponse>]
|
433
|
+
def official_work_locations20230301(opts = {})
|
434
|
+
data, _status_code, _headers = official_work_locations20230301_with_http_info(opts)
|
455
435
|
data
|
456
436
|
end
|
457
437
|
|
458
|
-
#
|
459
|
-
#
|
438
|
+
# Work locations
|
439
|
+
# The Location object is used to represent an address that can be associated with an employee
|
460
440
|
# @param [Hash] opts the optional parameters
|
461
|
-
# @return [Array<(Array<
|
462
|
-
def
|
441
|
+
# @return [Array<(Array<LocationResponse>, Integer, Hash)>] Array<LocationResponse> data, response status code and response headers
|
442
|
+
def official_work_locations20230301_with_http_info(opts = {})
|
463
443
|
if @api_client.config.debugging
|
464
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
444
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.official_work_locations20230301 ...'
|
465
445
|
end
|
466
446
|
# resource path
|
467
|
-
local_var_path = '/2023-03-01/
|
447
|
+
local_var_path = '/2023-03-01/official/work-locations'
|
468
448
|
|
469
449
|
# query parameters
|
470
450
|
query_params = opts[:query_params] || {}
|
@@ -481,13 +461,13 @@ module OpenapiClient
|
|
481
461
|
post_body = opts[:debug_body]
|
482
462
|
|
483
463
|
# return_type
|
484
|
-
return_type = opts[:debug_return_type] || 'Array<
|
464
|
+
return_type = opts[:debug_return_type] || 'Array<LocationResponse>'
|
485
465
|
|
486
466
|
# auth_names
|
487
467
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
488
468
|
|
489
469
|
new_options = opts.merge(
|
490
|
-
:operation => :"Class20230301Api.
|
470
|
+
:operation => :"Class20230301Api.official_work_locations20230301",
|
491
471
|
:header_params => header_params,
|
492
472
|
:query_params => query_params,
|
493
473
|
:form_params => form_params,
|
@@ -498,30 +478,30 @@ module OpenapiClient
|
|
498
478
|
|
499
479
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
500
480
|
if @api_client.config.debugging
|
501
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
481
|
+
@api_client.config.logger.debug "API called: Class20230301Api#official_work_locations20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
502
482
|
end
|
503
483
|
return data, status_code, headers
|
504
484
|
end
|
505
485
|
|
506
|
-
#
|
507
|
-
#
|
486
|
+
# Identity
|
487
|
+
# List information of the user for the respective account
|
508
488
|
# @param [Hash] opts the optional parameters
|
509
|
-
# @return [
|
510
|
-
def
|
511
|
-
data, _status_code, _headers =
|
489
|
+
# @return [IdentityResponse]
|
490
|
+
def officialdentity20230301(opts = {})
|
491
|
+
data, _status_code, _headers = officialdentity20230301_with_http_info(opts)
|
512
492
|
data
|
513
493
|
end
|
514
494
|
|
515
|
-
#
|
516
|
-
#
|
495
|
+
# Identity
|
496
|
+
# List information of the user for the respective account
|
517
497
|
# @param [Hash] opts the optional parameters
|
518
|
-
# @return [Array<(
|
519
|
-
def
|
498
|
+
# @return [Array<(IdentityResponse, Integer, Hash)>] IdentityResponse data, response status code and response headers
|
499
|
+
def officialdentity20230301_with_http_info(opts = {})
|
520
500
|
if @api_client.config.debugging
|
521
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
501
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.officialdentity20230301 ...'
|
522
502
|
end
|
523
503
|
# resource path
|
524
|
-
local_var_path = '/2023-03-01/
|
504
|
+
local_var_path = '/2023-03-01/official/identity'
|
525
505
|
|
526
506
|
# query parameters
|
527
507
|
query_params = opts[:query_params] || {}
|
@@ -538,13 +518,13 @@ module OpenapiClient
|
|
538
518
|
post_body = opts[:debug_body]
|
539
519
|
|
540
520
|
# return_type
|
541
|
-
return_type = opts[:debug_return_type] || '
|
521
|
+
return_type = opts[:debug_return_type] || 'IdentityResponse'
|
542
522
|
|
543
523
|
# auth_names
|
544
524
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
545
525
|
|
546
526
|
new_options = opts.merge(
|
547
|
-
:operation => :"Class20230301Api.
|
527
|
+
:operation => :"Class20230301Api.officialdentity20230301",
|
548
528
|
:header_params => header_params,
|
549
529
|
:query_params => query_params,
|
550
530
|
:form_params => form_params,
|
@@ -555,30 +535,30 @@ module OpenapiClient
|
|
555
535
|
|
556
536
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
557
537
|
if @api_client.config.debugging
|
558
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
538
|
+
@api_client.config.logger.debug "API called: Class20230301Api#officialdentity20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
559
539
|
end
|
560
540
|
return data, status_code, headers
|
561
541
|
end
|
562
542
|
|
563
|
-
#
|
564
|
-
# Retrieve
|
543
|
+
# Company
|
544
|
+
# Retrieve company information
|
565
545
|
# @param [Hash] opts the optional parameters
|
566
|
-
# @return [Array<
|
567
|
-
def
|
568
|
-
data, _status_code, _headers =
|
546
|
+
# @return [Array<CompanyResponse>]
|
547
|
+
def xhr_companies20230301(opts = {})
|
548
|
+
data, _status_code, _headers = xhr_companies20230301_with_http_info(opts)
|
569
549
|
data
|
570
550
|
end
|
571
551
|
|
572
|
-
#
|
573
|
-
# Retrieve
|
552
|
+
# Company
|
553
|
+
# Retrieve company information
|
574
554
|
# @param [Hash] opts the optional parameters
|
575
|
-
# @return [Array<(Array<
|
576
|
-
def
|
555
|
+
# @return [Array<(Array<CompanyResponse>, Integer, Hash)>] Array<CompanyResponse> data, response status code and response headers
|
556
|
+
def xhr_companies20230301_with_http_info(opts = {})
|
577
557
|
if @api_client.config.debugging
|
578
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
558
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_companies20230301 ...'
|
579
559
|
end
|
580
560
|
# resource path
|
581
|
-
local_var_path = '/2023-03-01/
|
561
|
+
local_var_path = '/2023-03-01/xhr/company'
|
582
562
|
|
583
563
|
# query parameters
|
584
564
|
query_params = opts[:query_params] || {}
|
@@ -595,13 +575,13 @@ module OpenapiClient
|
|
595
575
|
post_body = opts[:debug_body]
|
596
576
|
|
597
577
|
# return_type
|
598
|
-
return_type = opts[:debug_return_type] || 'Array<
|
578
|
+
return_type = opts[:debug_return_type] || 'Array<CompanyResponse>'
|
599
579
|
|
600
580
|
# auth_names
|
601
581
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
602
582
|
|
603
583
|
new_options = opts.merge(
|
604
|
-
:operation => :"Class20230301Api.
|
584
|
+
:operation => :"Class20230301Api.xhr_companies20230301",
|
605
585
|
:header_params => header_params,
|
606
586
|
:query_params => query_params,
|
607
587
|
:form_params => form_params,
|
@@ -612,30 +592,36 @@ module OpenapiClient
|
|
612
592
|
|
613
593
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
614
594
|
if @api_client.config.debugging
|
615
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
595
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_companies20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
616
596
|
end
|
617
597
|
return data, status_code, headers
|
618
598
|
end
|
619
599
|
|
620
|
-
#
|
621
|
-
#
|
600
|
+
# Create employee
|
601
|
+
# Creates a new Employee
|
602
|
+
# @param create_employee_request [CreateEmployeeRequest]
|
622
603
|
# @param [Hash] opts the optional parameters
|
623
|
-
# @return [
|
624
|
-
def
|
625
|
-
data, _status_code, _headers =
|
604
|
+
# @return [EmployeeResponse]
|
605
|
+
def xhr_create_employee20230301(create_employee_request, opts = {})
|
606
|
+
data, _status_code, _headers = xhr_create_employee20230301_with_http_info(create_employee_request, opts)
|
626
607
|
data
|
627
608
|
end
|
628
609
|
|
629
|
-
#
|
630
|
-
#
|
610
|
+
# Create employee
|
611
|
+
# Creates a new Employee
|
612
|
+
# @param create_employee_request [CreateEmployeeRequest]
|
631
613
|
# @param [Hash] opts the optional parameters
|
632
|
-
# @return [Array<(
|
633
|
-
def
|
614
|
+
# @return [Array<(EmployeeResponse, Integer, Hash)>] EmployeeResponse data, response status code and response headers
|
615
|
+
def xhr_create_employee20230301_with_http_info(create_employee_request, opts = {})
|
634
616
|
if @api_client.config.debugging
|
635
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
617
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_create_employee20230301 ...'
|
618
|
+
end
|
619
|
+
# verify the required parameter 'create_employee_request' is set
|
620
|
+
if @api_client.config.client_side_validation && create_employee_request.nil?
|
621
|
+
fail ArgumentError, "Missing the required parameter 'create_employee_request' when calling Class20230301Api.xhr_create_employee20230301"
|
636
622
|
end
|
637
623
|
# resource path
|
638
|
-
local_var_path = '/2023-03-01/
|
624
|
+
local_var_path = '/2023-03-01/xhr/employee'
|
639
625
|
|
640
626
|
# query parameters
|
641
627
|
query_params = opts[:query_params] || {}
|
@@ -644,21 +630,23 @@ module OpenapiClient
|
|
644
630
|
header_params = opts[:header_params] || {}
|
645
631
|
# HTTP header 'Accept' (if needed)
|
646
632
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
633
|
+
# HTTP header 'Content-Type'
|
634
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
647
635
|
|
648
636
|
# form parameters
|
649
637
|
form_params = opts[:form_params] || {}
|
650
638
|
|
651
639
|
# http body (model)
|
652
|
-
post_body = opts[:debug_body]
|
640
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_employee_request)
|
653
641
|
|
654
642
|
# return_type
|
655
|
-
return_type = opts[:debug_return_type] || '
|
643
|
+
return_type = opts[:debug_return_type] || 'EmployeeResponse'
|
656
644
|
|
657
645
|
# auth_names
|
658
646
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
659
647
|
|
660
648
|
new_options = opts.merge(
|
661
|
-
:operation => :"Class20230301Api.
|
649
|
+
:operation => :"Class20230301Api.xhr_create_employee20230301",
|
662
650
|
:header_params => header_params,
|
663
651
|
:query_params => query_params,
|
664
652
|
:form_params => form_params,
|
@@ -667,32 +655,32 @@ module OpenapiClient
|
|
667
655
|
:return_type => return_type
|
668
656
|
)
|
669
657
|
|
670
|
-
data, status_code, headers = @api_client.call_api(:
|
658
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
671
659
|
if @api_client.config.debugging
|
672
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
660
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_create_employee20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
673
661
|
end
|
674
662
|
return data, status_code, headers
|
675
663
|
end
|
676
664
|
|
677
|
-
#
|
678
|
-
#
|
665
|
+
# Employees
|
666
|
+
# List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
679
667
|
# @param [Hash] opts the optional parameters
|
680
|
-
# @return [Array<
|
681
|
-
def
|
682
|
-
data, _status_code, _headers =
|
668
|
+
# @return [Array<EmployeeResponse>]
|
669
|
+
def xhr_employees20230301(opts = {})
|
670
|
+
data, _status_code, _headers = xhr_employees20230301_with_http_info(opts)
|
683
671
|
data
|
684
672
|
end
|
685
673
|
|
686
|
-
#
|
687
|
-
#
|
674
|
+
# Employees
|
675
|
+
# List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
|
688
676
|
# @param [Hash] opts the optional parameters
|
689
|
-
# @return [Array<(Array<
|
690
|
-
def
|
677
|
+
# @return [Array<(Array<EmployeeResponse>, Integer, Hash)>] Array<EmployeeResponse> data, response status code and response headers
|
678
|
+
def xhr_employees20230301_with_http_info(opts = {})
|
691
679
|
if @api_client.config.debugging
|
692
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
680
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_employees20230301 ...'
|
693
681
|
end
|
694
682
|
# resource path
|
695
|
-
local_var_path = '/2023-03-01/
|
683
|
+
local_var_path = '/2023-03-01/xhr/employees'
|
696
684
|
|
697
685
|
# query parameters
|
698
686
|
query_params = opts[:query_params] || {}
|
@@ -709,13 +697,13 @@ module OpenapiClient
|
|
709
697
|
post_body = opts[:debug_body]
|
710
698
|
|
711
699
|
# return_type
|
712
|
-
return_type = opts[:debug_return_type] || 'Array<
|
700
|
+
return_type = opts[:debug_return_type] || 'Array<EmployeeResponse>'
|
713
701
|
|
714
702
|
# auth_names
|
715
703
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
716
704
|
|
717
705
|
new_options = opts.merge(
|
718
|
-
:operation => :"Class20230301Api.
|
706
|
+
:operation => :"Class20230301Api.xhr_employees20230301",
|
719
707
|
:header_params => header_params,
|
720
708
|
:query_params => query_params,
|
721
709
|
:form_params => form_params,
|
@@ -726,36 +714,30 @@ module OpenapiClient
|
|
726
714
|
|
727
715
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
728
716
|
if @api_client.config.debugging
|
729
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
717
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_employees20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
730
718
|
end
|
731
719
|
return data, status_code, headers
|
732
720
|
end
|
733
721
|
|
734
|
-
#
|
735
|
-
#
|
736
|
-
# @param create_employee_request [CreateEmployeeRequest]
|
722
|
+
# Groups
|
723
|
+
# The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
737
724
|
# @param [Hash] opts the optional parameters
|
738
|
-
# @return [
|
739
|
-
def
|
740
|
-
data, _status_code, _headers =
|
725
|
+
# @return [Array<GroupResponse>]
|
726
|
+
def xhr_groups20230301(opts = {})
|
727
|
+
data, _status_code, _headers = xhr_groups20230301_with_http_info(opts)
|
741
728
|
data
|
742
729
|
end
|
743
730
|
|
744
|
-
#
|
745
|
-
#
|
746
|
-
# @param create_employee_request [CreateEmployeeRequest]
|
731
|
+
# Groups
|
732
|
+
# The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.
|
747
733
|
# @param [Hash] opts the optional parameters
|
748
|
-
# @return [Array<(
|
749
|
-
def
|
734
|
+
# @return [Array<(Array<GroupResponse>, Integer, Hash)>] Array<GroupResponse> data, response status code and response headers
|
735
|
+
def xhr_groups20230301_with_http_info(opts = {})
|
750
736
|
if @api_client.config.debugging
|
751
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
752
|
-
end
|
753
|
-
# verify the required parameter 'create_employee_request' is set
|
754
|
-
if @api_client.config.client_side_validation && create_employee_request.nil?
|
755
|
-
fail ArgumentError, "Missing the required parameter 'create_employee_request' when calling Class20230301Api.official_create_employee20230301"
|
737
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_groups20230301 ...'
|
756
738
|
end
|
757
739
|
# resource path
|
758
|
-
local_var_path = '/2023-03-01/
|
740
|
+
local_var_path = '/2023-03-01/xhr/groups'
|
759
741
|
|
760
742
|
# query parameters
|
761
743
|
query_params = opts[:query_params] || {}
|
@@ -764,23 +746,21 @@ module OpenapiClient
|
|
764
746
|
header_params = opts[:header_params] || {}
|
765
747
|
# HTTP header 'Accept' (if needed)
|
766
748
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
767
|
-
# HTTP header 'Content-Type'
|
768
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
769
749
|
|
770
750
|
# form parameters
|
771
751
|
form_params = opts[:form_params] || {}
|
772
752
|
|
773
753
|
# http body (model)
|
774
|
-
post_body = opts[:debug_body]
|
754
|
+
post_body = opts[:debug_body]
|
775
755
|
|
776
756
|
# return_type
|
777
|
-
return_type = opts[:debug_return_type] || '
|
757
|
+
return_type = opts[:debug_return_type] || 'Array<GroupResponse>'
|
778
758
|
|
779
759
|
# auth_names
|
780
760
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
781
761
|
|
782
762
|
new_options = opts.merge(
|
783
|
-
:operation => :"Class20230301Api.
|
763
|
+
:operation => :"Class20230301Api.xhr_groups20230301",
|
784
764
|
:header_params => header_params,
|
785
765
|
:query_params => query_params,
|
786
766
|
:form_params => form_params,
|
@@ -789,32 +769,32 @@ module OpenapiClient
|
|
789
769
|
:return_type => return_type
|
790
770
|
)
|
791
771
|
|
792
|
-
data, status_code, headers = @api_client.call_api(:
|
772
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
793
773
|
if @api_client.config.debugging
|
794
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
774
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_groups20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
795
775
|
end
|
796
776
|
return data, status_code, headers
|
797
777
|
end
|
798
778
|
|
799
|
-
#
|
800
|
-
# List
|
779
|
+
# Identity
|
780
|
+
# List information of the user for the respective account
|
801
781
|
# @param [Hash] opts the optional parameters
|
802
|
-
# @return [
|
803
|
-
def
|
804
|
-
data, _status_code, _headers =
|
782
|
+
# @return [IdentityResponse]
|
783
|
+
def xhr_identity20230301(opts = {})
|
784
|
+
data, _status_code, _headers = xhr_identity20230301_with_http_info(opts)
|
805
785
|
data
|
806
786
|
end
|
807
787
|
|
808
|
-
#
|
809
|
-
# List
|
788
|
+
# Identity
|
789
|
+
# List information of the user for the respective account
|
810
790
|
# @param [Hash] opts the optional parameters
|
811
|
-
# @return [Array<(
|
812
|
-
def
|
791
|
+
# @return [Array<(IdentityResponse, Integer, Hash)>] IdentityResponse data, response status code and response headers
|
792
|
+
def xhr_identity20230301_with_http_info(opts = {})
|
813
793
|
if @api_client.config.debugging
|
814
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
794
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_identity20230301 ...'
|
815
795
|
end
|
816
796
|
# resource path
|
817
|
-
local_var_path = '/2023-03-01/
|
797
|
+
local_var_path = '/2023-03-01/xhr/identity'
|
818
798
|
|
819
799
|
# query parameters
|
820
800
|
query_params = opts[:query_params] || {}
|
@@ -831,13 +811,13 @@ module OpenapiClient
|
|
831
811
|
post_body = opts[:debug_body]
|
832
812
|
|
833
813
|
# return_type
|
834
|
-
return_type = opts[:debug_return_type] || '
|
814
|
+
return_type = opts[:debug_return_type] || 'IdentityResponse'
|
835
815
|
|
836
816
|
# auth_names
|
837
817
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
838
818
|
|
839
819
|
new_options = opts.merge(
|
840
|
-
:operation => :"Class20230301Api.
|
820
|
+
:operation => :"Class20230301Api.xhr_identity20230301",
|
841
821
|
:header_params => header_params,
|
842
822
|
:query_params => query_params,
|
843
823
|
:form_params => form_params,
|
@@ -848,33 +828,47 @@ module OpenapiClient
|
|
848
828
|
|
849
829
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
850
830
|
if @api_client.config.debugging
|
851
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
831
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_identity20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
852
832
|
end
|
853
833
|
return data, status_code, headers
|
854
834
|
end
|
855
835
|
|
856
|
-
#
|
857
|
-
#
|
836
|
+
# Payruns
|
837
|
+
# List all the pay runs that occurred during the respective period. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
838
|
+
# @param start_date [Date] The start date of the search period
|
839
|
+
# @param end_date [Date] The end date of the search period
|
858
840
|
# @param [Hash] opts the optional parameters
|
859
|
-
# @return [Array<
|
860
|
-
def
|
861
|
-
data, _status_code, _headers =
|
841
|
+
# @return [Array<PayrunResponse>]
|
842
|
+
def xhr_payruns20230301(start_date, end_date, opts = {})
|
843
|
+
data, _status_code, _headers = xhr_payruns20230301_with_http_info(start_date, end_date, opts)
|
862
844
|
data
|
863
845
|
end
|
864
846
|
|
865
|
-
#
|
866
|
-
#
|
847
|
+
# Payruns
|
848
|
+
# List all the pay runs that occurred during the respective period. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
849
|
+
# @param start_date [Date] The start date of the search period
|
850
|
+
# @param end_date [Date] The end date of the search period
|
867
851
|
# @param [Hash] opts the optional parameters
|
868
|
-
# @return [Array<(Array<
|
869
|
-
def
|
852
|
+
# @return [Array<(Array<PayrunResponse>, Integer, Hash)>] Array<PayrunResponse> data, response status code and response headers
|
853
|
+
def xhr_payruns20230301_with_http_info(start_date, end_date, opts = {})
|
870
854
|
if @api_client.config.debugging
|
871
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
855
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_payruns20230301 ...'
|
856
|
+
end
|
857
|
+
# verify the required parameter 'start_date' is set
|
858
|
+
if @api_client.config.client_side_validation && start_date.nil?
|
859
|
+
fail ArgumentError, "Missing the required parameter 'start_date' when calling Class20230301Api.xhr_payruns20230301"
|
860
|
+
end
|
861
|
+
# verify the required parameter 'end_date' is set
|
862
|
+
if @api_client.config.client_side_validation && end_date.nil?
|
863
|
+
fail ArgumentError, "Missing the required parameter 'end_date' when calling Class20230301Api.xhr_payruns20230301"
|
872
864
|
end
|
873
865
|
# resource path
|
874
|
-
local_var_path = '/2023-03-01/
|
866
|
+
local_var_path = '/2023-03-01/xhr/payruns'
|
875
867
|
|
876
868
|
# query parameters
|
877
869
|
query_params = opts[:query_params] || {}
|
870
|
+
query_params[:'start_date'] = start_date
|
871
|
+
query_params[:'end_date'] = end_date
|
878
872
|
|
879
873
|
# header parameters
|
880
874
|
header_params = opts[:header_params] || {}
|
@@ -888,13 +882,13 @@ module OpenapiClient
|
|
888
882
|
post_body = opts[:debug_body]
|
889
883
|
|
890
884
|
# return_type
|
891
|
-
return_type = opts[:debug_return_type] || 'Array<
|
885
|
+
return_type = opts[:debug_return_type] || 'Array<PayrunResponse>'
|
892
886
|
|
893
887
|
# auth_names
|
894
888
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
895
889
|
|
896
890
|
new_options = opts.merge(
|
897
|
-
:operation => :"Class20230301Api.
|
891
|
+
:operation => :"Class20230301Api.xhr_payruns20230301",
|
898
892
|
:header_params => header_params,
|
899
893
|
:query_params => query_params,
|
900
894
|
:form_params => form_params,
|
@@ -905,30 +899,36 @@ module OpenapiClient
|
|
905
899
|
|
906
900
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
907
901
|
if @api_client.config.debugging
|
908
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
902
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_payruns20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
909
903
|
end
|
910
904
|
return data, status_code, headers
|
911
905
|
end
|
912
906
|
|
913
|
-
#
|
914
|
-
#
|
907
|
+
# Payslips
|
908
|
+
# Retrieves payslips from a specific payrun. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
909
|
+
# @param payrun_id [String] The id of the payrun.
|
915
910
|
# @param [Hash] opts the optional parameters
|
916
|
-
# @return [Array<
|
917
|
-
def
|
918
|
-
data, _status_code, _headers =
|
911
|
+
# @return [Array<PayslipResponse>]
|
912
|
+
def xhr_payslips20230301(payrun_id, opts = {})
|
913
|
+
data, _status_code, _headers = xhr_payslips20230301_with_http_info(payrun_id, opts)
|
919
914
|
data
|
920
915
|
end
|
921
916
|
|
922
|
-
#
|
923
|
-
#
|
917
|
+
# Payslips
|
918
|
+
# Retrieves payslips from a specific payrun. Supported integrations: - sageone - simplepay.ie - brightpay connect
|
919
|
+
# @param payrun_id [String] The id of the payrun.
|
924
920
|
# @param [Hash] opts the optional parameters
|
925
|
-
# @return [Array<(Array<
|
926
|
-
def
|
921
|
+
# @return [Array<(Array<PayslipResponse>, Integer, Hash)>] Array<PayslipResponse> data, response status code and response headers
|
922
|
+
def xhr_payslips20230301_with_http_info(payrun_id, opts = {})
|
927
923
|
if @api_client.config.debugging
|
928
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
924
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_payslips20230301 ...'
|
925
|
+
end
|
926
|
+
# verify the required parameter 'payrun_id' is set
|
927
|
+
if @api_client.config.client_side_validation && payrun_id.nil?
|
928
|
+
fail ArgumentError, "Missing the required parameter 'payrun_id' when calling Class20230301Api.xhr_payslips20230301"
|
929
929
|
end
|
930
930
|
# resource path
|
931
|
-
local_var_path = '/2023-03-01/
|
931
|
+
local_var_path = '/2023-03-01/xhr/payruns/{payrun_id}'.sub('{' + 'payrun_id' + '}', CGI.escape(payrun_id.to_s))
|
932
932
|
|
933
933
|
# query parameters
|
934
934
|
query_params = opts[:query_params] || {}
|
@@ -945,13 +945,13 @@ module OpenapiClient
|
|
945
945
|
post_body = opts[:debug_body]
|
946
946
|
|
947
947
|
# return_type
|
948
|
-
return_type = opts[:debug_return_type] || 'Array<
|
948
|
+
return_type = opts[:debug_return_type] || 'Array<PayslipResponse>'
|
949
949
|
|
950
950
|
# auth_names
|
951
951
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
952
952
|
|
953
953
|
new_options = opts.merge(
|
954
|
-
:operation => :"Class20230301Api.
|
954
|
+
:operation => :"Class20230301Api.xhr_payslips20230301",
|
955
955
|
:header_params => header_params,
|
956
956
|
:query_params => query_params,
|
957
957
|
:form_params => form_params,
|
@@ -962,30 +962,30 @@ module OpenapiClient
|
|
962
962
|
|
963
963
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
964
964
|
if @api_client.config.debugging
|
965
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
965
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_payslips20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
966
966
|
end
|
967
967
|
return data, status_code, headers
|
968
968
|
end
|
969
969
|
|
970
|
-
# Time off
|
971
|
-
# Retrieve time off
|
970
|
+
# Time off balances
|
971
|
+
# Retrieve all time off balances.
|
972
972
|
# @param [Hash] opts the optional parameters
|
973
|
-
# @return [Array<
|
974
|
-
def
|
975
|
-
data, _status_code, _headers =
|
973
|
+
# @return [Array<TimeOffBalanceResponse>]
|
974
|
+
def xhr_time_off_balances20230301(opts = {})
|
975
|
+
data, _status_code, _headers = xhr_time_off_balances20230301_with_http_info(opts)
|
976
976
|
data
|
977
977
|
end
|
978
978
|
|
979
|
-
# Time off
|
980
|
-
# Retrieve time off
|
979
|
+
# Time off balances
|
980
|
+
# Retrieve all time off balances.
|
981
981
|
# @param [Hash] opts the optional parameters
|
982
|
-
# @return [Array<(Array<
|
983
|
-
def
|
982
|
+
# @return [Array<(Array<TimeOffBalanceResponse>, Integer, Hash)>] Array<TimeOffBalanceResponse> data, response status code and response headers
|
983
|
+
def xhr_time_off_balances20230301_with_http_info(opts = {})
|
984
984
|
if @api_client.config.debugging
|
985
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
985
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_time_off_balances20230301 ...'
|
986
986
|
end
|
987
987
|
# resource path
|
988
|
-
local_var_path = '/2023-03-01/
|
988
|
+
local_var_path = '/2023-03-01/xhr/time-off-balances'
|
989
989
|
|
990
990
|
# query parameters
|
991
991
|
query_params = opts[:query_params] || {}
|
@@ -1002,13 +1002,13 @@ module OpenapiClient
|
|
1002
1002
|
post_body = opts[:debug_body]
|
1003
1003
|
|
1004
1004
|
# return_type
|
1005
|
-
return_type = opts[:debug_return_type] || 'Array<
|
1005
|
+
return_type = opts[:debug_return_type] || 'Array<TimeOffBalanceResponse>'
|
1006
1006
|
|
1007
1007
|
# auth_names
|
1008
1008
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
1009
1009
|
|
1010
1010
|
new_options = opts.merge(
|
1011
|
-
:operation => :"Class20230301Api.
|
1011
|
+
:operation => :"Class20230301Api.xhr_time_off_balances20230301",
|
1012
1012
|
:header_params => header_params,
|
1013
1013
|
:query_params => query_params,
|
1014
1014
|
:form_params => form_params,
|
@@ -1019,30 +1019,30 @@ module OpenapiClient
|
|
1019
1019
|
|
1020
1020
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1021
1021
|
if @api_client.config.debugging
|
1022
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
1022
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_time_off_balances20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1023
1023
|
end
|
1024
1024
|
return data, status_code, headers
|
1025
1025
|
end
|
1026
1026
|
|
1027
|
-
#
|
1028
|
-
# Retrieve
|
1027
|
+
# Time off entries
|
1028
|
+
# Retrieve time off / absence entries
|
1029
1029
|
# @param [Hash] opts the optional parameters
|
1030
|
-
# @return [Array<
|
1031
|
-
def
|
1032
|
-
data, _status_code, _headers =
|
1030
|
+
# @return [Array<TimeOffEntryResponse>]
|
1031
|
+
def xhr_time_off_entries20230301(opts = {})
|
1032
|
+
data, _status_code, _headers = xhr_time_off_entries20230301_with_http_info(opts)
|
1033
1033
|
data
|
1034
1034
|
end
|
1035
1035
|
|
1036
|
-
#
|
1037
|
-
# Retrieve
|
1036
|
+
# Time off entries
|
1037
|
+
# Retrieve time off / absence entries
|
1038
1038
|
# @param [Hash] opts the optional parameters
|
1039
|
-
# @return [Array<(Array<
|
1040
|
-
def
|
1039
|
+
# @return [Array<(Array<TimeOffEntryResponse>, Integer, Hash)>] Array<TimeOffEntryResponse> data, response status code and response headers
|
1040
|
+
def xhr_time_off_entries20230301_with_http_info(opts = {})
|
1041
1041
|
if @api_client.config.debugging
|
1042
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
1042
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_time_off_entries20230301 ...'
|
1043
1043
|
end
|
1044
1044
|
# resource path
|
1045
|
-
local_var_path = '/2023-03-01/
|
1045
|
+
local_var_path = '/2023-03-01/xhr/time-off-entries'
|
1046
1046
|
|
1047
1047
|
# query parameters
|
1048
1048
|
query_params = opts[:query_params] || {}
|
@@ -1059,13 +1059,13 @@ module OpenapiClient
|
|
1059
1059
|
post_body = opts[:debug_body]
|
1060
1060
|
|
1061
1061
|
# return_type
|
1062
|
-
return_type = opts[:debug_return_type] || 'Array<
|
1062
|
+
return_type = opts[:debug_return_type] || 'Array<TimeOffEntryResponse>'
|
1063
1063
|
|
1064
1064
|
# auth_names
|
1065
1065
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
1066
1066
|
|
1067
1067
|
new_options = opts.merge(
|
1068
|
-
:operation => :"Class20230301Api.
|
1068
|
+
:operation => :"Class20230301Api.xhr_time_off_entries20230301",
|
1069
1069
|
:header_params => header_params,
|
1070
1070
|
:query_params => query_params,
|
1071
1071
|
:form_params => form_params,
|
@@ -1076,30 +1076,30 @@ module OpenapiClient
|
|
1076
1076
|
|
1077
1077
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1078
1078
|
if @api_client.config.debugging
|
1079
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
1079
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_time_off_entries20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1080
1080
|
end
|
1081
1081
|
return data, status_code, headers
|
1082
1082
|
end
|
1083
1083
|
|
1084
|
-
#
|
1085
|
-
#
|
1084
|
+
# Timesheets
|
1085
|
+
# Retrieve Timesheets
|
1086
1086
|
# @param [Hash] opts the optional parameters
|
1087
|
-
# @return [Array<
|
1088
|
-
def
|
1089
|
-
data, _status_code, _headers =
|
1087
|
+
# @return [Array<TimesheetResponse>]
|
1088
|
+
def xhr_timesheets20230301(opts = {})
|
1089
|
+
data, _status_code, _headers = xhr_timesheets20230301_with_http_info(opts)
|
1090
1090
|
data
|
1091
1091
|
end
|
1092
1092
|
|
1093
|
-
#
|
1094
|
-
#
|
1093
|
+
# Timesheets
|
1094
|
+
# Retrieve Timesheets
|
1095
1095
|
# @param [Hash] opts the optional parameters
|
1096
|
-
# @return [Array<(Array<
|
1097
|
-
def
|
1096
|
+
# @return [Array<(Array<TimesheetResponse>, Integer, Hash)>] Array<TimesheetResponse> data, response status code and response headers
|
1097
|
+
def xhr_timesheets20230301_with_http_info(opts = {})
|
1098
1098
|
if @api_client.config.debugging
|
1099
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
1099
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_timesheets20230301 ...'
|
1100
1100
|
end
|
1101
1101
|
# resource path
|
1102
|
-
local_var_path = '/2023-03-01/
|
1102
|
+
local_var_path = '/2023-03-01/xhr/timesheets'
|
1103
1103
|
|
1104
1104
|
# query parameters
|
1105
1105
|
query_params = opts[:query_params] || {}
|
@@ -1116,13 +1116,13 @@ module OpenapiClient
|
|
1116
1116
|
post_body = opts[:debug_body]
|
1117
1117
|
|
1118
1118
|
# return_type
|
1119
|
-
return_type = opts[:debug_return_type] || 'Array<
|
1119
|
+
return_type = opts[:debug_return_type] || 'Array<TimesheetResponse>'
|
1120
1120
|
|
1121
1121
|
# auth_names
|
1122
1122
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
1123
1123
|
|
1124
1124
|
new_options = opts.merge(
|
1125
|
-
:operation => :"Class20230301Api.
|
1125
|
+
:operation => :"Class20230301Api.xhr_timesheets20230301",
|
1126
1126
|
:header_params => header_params,
|
1127
1127
|
:query_params => query_params,
|
1128
1128
|
:form_params => form_params,
|
@@ -1133,30 +1133,30 @@ module OpenapiClient
|
|
1133
1133
|
|
1134
1134
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1135
1135
|
if @api_client.config.debugging
|
1136
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
1136
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_timesheets20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1137
1137
|
end
|
1138
1138
|
return data, status_code, headers
|
1139
1139
|
end
|
1140
1140
|
|
1141
|
-
#
|
1142
|
-
#
|
1141
|
+
# Work locations
|
1142
|
+
# The Location object is used to represent an address that can be associated with an employee
|
1143
1143
|
# @param [Hash] opts the optional parameters
|
1144
|
-
# @return [
|
1145
|
-
def
|
1146
|
-
data, _status_code, _headers =
|
1144
|
+
# @return [Array<LocationResponse>]
|
1145
|
+
def xhr_work_locations20230301(opts = {})
|
1146
|
+
data, _status_code, _headers = xhr_work_locations20230301_with_http_info(opts)
|
1147
1147
|
data
|
1148
1148
|
end
|
1149
1149
|
|
1150
|
-
#
|
1151
|
-
#
|
1150
|
+
# Work locations
|
1151
|
+
# The Location object is used to represent an address that can be associated with an employee
|
1152
1152
|
# @param [Hash] opts the optional parameters
|
1153
|
-
# @return [Array<(
|
1154
|
-
def
|
1153
|
+
# @return [Array<(Array<LocationResponse>, Integer, Hash)>] Array<LocationResponse> data, response status code and response headers
|
1154
|
+
def xhr_work_locations20230301_with_http_info(opts = {})
|
1155
1155
|
if @api_client.config.debugging
|
1156
|
-
@api_client.config.logger.debug 'Calling API: Class20230301Api.
|
1156
|
+
@api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_work_locations20230301 ...'
|
1157
1157
|
end
|
1158
1158
|
# resource path
|
1159
|
-
local_var_path = '/2023-03-01/
|
1159
|
+
local_var_path = '/2023-03-01/xhr/work-locations'
|
1160
1160
|
|
1161
1161
|
# query parameters
|
1162
1162
|
query_params = opts[:query_params] || {}
|
@@ -1173,13 +1173,13 @@ module OpenapiClient
|
|
1173
1173
|
post_body = opts[:debug_body]
|
1174
1174
|
|
1175
1175
|
# return_type
|
1176
|
-
return_type = opts[:debug_return_type] || '
|
1176
|
+
return_type = opts[:debug_return_type] || 'Array<LocationResponse>'
|
1177
1177
|
|
1178
1178
|
# auth_names
|
1179
1179
|
auth_names = opts[:debug_auth_names] || ['access-token']
|
1180
1180
|
|
1181
1181
|
new_options = opts.merge(
|
1182
|
-
:operation => :"Class20230301Api.
|
1182
|
+
:operation => :"Class20230301Api.xhr_work_locations20230301",
|
1183
1183
|
:header_params => header_params,
|
1184
1184
|
:query_params => query_params,
|
1185
1185
|
:form_params => form_params,
|
@@ -1190,7 +1190,7 @@ module OpenapiClient
|
|
1190
1190
|
|
1191
1191
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1192
1192
|
if @api_client.config.debugging
|
1193
|
-
@api_client.config.logger.debug "API called: Class20230301Api#
|
1193
|
+
@api_client.config.logger.debug "API called: Class20230301Api#xhr_work_locations20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1194
1194
|
end
|
1195
1195
|
return data, status_code, headers
|
1196
1196
|
end
|