affixapi 1.1.49 → 1.1.51
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 +1 -0
- data/docs/EmployeeResponse.md +1 -1
- data/docs/EmployeeResponseManager.md +26 -0
- data/lib/openapi_client/models/address_no_non_null_request.rb +2 -2
- data/lib/openapi_client/models/address_response.rb +2 -2
- data/lib/openapi_client/models/employee_response.rb +1 -1
- data/lib/openapi_client/models/employee_response_manager.rb +260 -0
- data/lib/openapi_client/models/employment_no_null_enum_request.rb +1 -5
- data/lib/openapi_client/version.rb +1 -1
- data/lib/openapi_client.rb +1 -0
- data/spec/models/address_no_non_null_request_spec.rb +1 -1
- data/spec/models/address_response_spec.rb +1 -1
- data/spec/models/employee_response_manager_spec.rb +58 -0
- metadata +40 -36
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d1eb4f6e62394c98a988f286660f47721d8e2f5ccd0dadb782a8a61ace1d03dc
|
4
|
+
data.tar.gz: 0e7505f3bfe7527d6309bcd11796ca757afc5d88ac4f4e01a38fd7d94adbee2b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7fc2969c018ab5034178c9002f8cb1e226475c7f5579803499316e131035488bab0fa49776cf803bff23ff64fcb8d28598b9bc389e8527d42ca4878c2b22f757
|
7
|
+
data.tar.gz: 7b10f0feca457629a3f5a89b5708d776b450e8c7973ca41e216d11ba677ac3f8d06e2df1ceb29a9a7a8b24ce14468d0e490a3f196cfdb10420d5aa4407e1e8b2
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -331,6 +331,7 @@ Class | Method | HTTP request | Description
|
|
331
331
|
- [OpenapiClient::CurrencyResponse](docs/CurrencyResponse.md)
|
332
332
|
- [OpenapiClient::DisconnectResponse](docs/DisconnectResponse.md)
|
333
333
|
- [OpenapiClient::EmployeeResponse](docs/EmployeeResponse.md)
|
334
|
+
- [OpenapiClient::EmployeeResponseManager](docs/EmployeeResponseManager.md)
|
334
335
|
- [OpenapiClient::EmploymentNoNullEnumRequest](docs/EmploymentNoNullEnumRequest.md)
|
335
336
|
- [OpenapiClient::EmploymentResponse](docs/EmploymentResponse.md)
|
336
337
|
- [OpenapiClient::GroupNoNullEnumRequest](docs/GroupNoNullEnumRequest.md)
|
data/docs/EmployeeResponse.md
CHANGED
@@ -28,7 +28,7 @@
|
|
28
28
|
| **avatar** | **String** | | |
|
29
29
|
| **home_location** | [**AddressResponse**](AddressResponse.md) | | |
|
30
30
|
| **work_location** | [**LocationResponse**](LocationResponse.md) | | |
|
31
|
-
| **manager** | [**
|
31
|
+
| **manager** | [**EmployeeResponseManager**](EmployeeResponseManager.md) | | |
|
32
32
|
| **bank_account** | [**CreateEmployeeRequestBankAccount**](CreateEmployeeRequestBankAccount.md) | | |
|
33
33
|
| **employments** | [**Array<EmploymentResponse>**](EmploymentResponse.md) | | |
|
34
34
|
| **custom_fields** | **Object** | | |
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# OpenapiClient::EmployeeResponseManager
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_name** | **String** | | |
|
8
|
+
| **last_name** | **String** | | |
|
9
|
+
| **id** | **String** | the Affix-assigned ID of the individual. Nullable if the system only reports the name of the manager; not their ID | |
|
10
|
+
| **work_email** | **String** | | |
|
11
|
+
| **remote_id** | **String** | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'openapi_client'
|
17
|
+
|
18
|
+
instance = OpenapiClient::EmployeeResponseManager.new(
|
19
|
+
first_name: null,
|
20
|
+
last_name: null,
|
21
|
+
id: null,
|
22
|
+
work_email: null,
|
23
|
+
remote_id: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -133,7 +133,7 @@ module OpenapiClient
|
|
133
133
|
# Check to see if the all the properties in the model are valid
|
134
134
|
# @return true if the model is valid
|
135
135
|
def valid?
|
136
|
-
country_validator = EnumAttributeValidator.new('String', ["AT", "BE", "CA", "CH", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PL", "RO", "SE", "SG", "SK", "US"])
|
136
|
+
country_validator = EnumAttributeValidator.new('String', ["AT", "AU", "BE", "CA", "CH", "CN", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "HK", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PH", "PL", "RO", "SE", "SG", "SK", "TW", "US"])
|
137
137
|
return false unless country_validator.valid?(@country)
|
138
138
|
true
|
139
139
|
end
|
@@ -141,7 +141,7 @@ module OpenapiClient
|
|
141
141
|
# Custom attribute writer method checking allowed values (enum).
|
142
142
|
# @param [Object] country Object to be assigned
|
143
143
|
def country=(country)
|
144
|
-
validator = EnumAttributeValidator.new('String', ["AT", "BE", "CA", "CH", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PL", "RO", "SE", "SG", "SK", "US"])
|
144
|
+
validator = EnumAttributeValidator.new('String', ["AT", "AU", "BE", "CA", "CH", "CN", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "HK", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PH", "PL", "RO", "SE", "SG", "SK", "TW", "US"])
|
145
145
|
unless validator.valid?(country)
|
146
146
|
fail ArgumentError, "invalid value for \"country\", must be one of #{validator.allowable_values}."
|
147
147
|
end
|
@@ -133,7 +133,7 @@ module OpenapiClient
|
|
133
133
|
# Check to see if the all the properties in the model are valid
|
134
134
|
# @return true if the model is valid
|
135
135
|
def valid?
|
136
|
-
country_validator = EnumAttributeValidator.new('String', ["null", "AT", "AU", "BE", "CA", "CH", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PL", "RO", "SE", "SG", "SK", "US"])
|
136
|
+
country_validator = EnumAttributeValidator.new('String', ["null", "AT", "AU", "BE", "CA", "CH", "CN", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "HK", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PH", "PL", "RO", "SE", "SG", "SK", "TW", "US"])
|
137
137
|
return false unless country_validator.valid?(@country)
|
138
138
|
true
|
139
139
|
end
|
@@ -141,7 +141,7 @@ module OpenapiClient
|
|
141
141
|
# Custom attribute writer method checking allowed values (enum).
|
142
142
|
# @param [Object] country Object to be assigned
|
143
143
|
def country=(country)
|
144
|
-
validator = EnumAttributeValidator.new('String', ["null", "AT", "AU", "BE", "CA", "CH", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PL", "RO", "SE", "SG", "SK", "US"])
|
144
|
+
validator = EnumAttributeValidator.new('String', ["null", "AT", "AU", "BE", "CA", "CH", "CN", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "HK", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PH", "PL", "RO", "SE", "SG", "SK", "TW", "US"])
|
145
145
|
unless validator.valid?(country)
|
146
146
|
fail ArgumentError, "invalid value for \"country\", must be one of #{validator.allowable_values}."
|
147
147
|
end
|
@@ -169,7 +169,7 @@ module OpenapiClient
|
|
169
169
|
:'avatar' => :'String',
|
170
170
|
:'home_location' => :'AddressResponse',
|
171
171
|
:'work_location' => :'LocationResponse',
|
172
|
-
:'manager' => :'
|
172
|
+
:'manager' => :'EmployeeResponseManager',
|
173
173
|
:'bank_account' => :'CreateEmployeeRequestBankAccount',
|
174
174
|
:'employments' => :'Array<EmploymentResponse>',
|
175
175
|
:'custom_fields' => :'Object',
|
@@ -0,0 +1,260 @@
|
|
1
|
+
=begin
|
2
|
+
#Affix API
|
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 (xhr mode) ### dev ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q' \\ 'https://dev.api.affixapi.com/2023-03-01/xhr/employees' ``` ### prod ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg' \\ '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
|
+
|
6
|
+
The version of the OpenAPI document: 2023-03-01
|
7
|
+
Contact: developers@affixapi.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module OpenapiClient
|
17
|
+
class EmployeeResponseManager
|
18
|
+
attr_accessor :first_name
|
19
|
+
|
20
|
+
attr_accessor :last_name
|
21
|
+
|
22
|
+
# the Affix-assigned ID of the individual. Nullable if the system only reports the name of the manager; not their ID
|
23
|
+
attr_accessor :id
|
24
|
+
|
25
|
+
attr_accessor :work_email
|
26
|
+
|
27
|
+
attr_accessor :remote_id
|
28
|
+
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
30
|
+
def self.attribute_map
|
31
|
+
{
|
32
|
+
:'first_name' => :'first_name',
|
33
|
+
:'last_name' => :'last_name',
|
34
|
+
:'id' => :'id',
|
35
|
+
:'work_email' => :'work_email',
|
36
|
+
:'remote_id' => :'remote_id'
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
# Returns all the JSON keys this model knows about
|
41
|
+
def self.acceptable_attributes
|
42
|
+
attribute_map.values
|
43
|
+
end
|
44
|
+
|
45
|
+
# Attribute type mapping.
|
46
|
+
def self.openapi_types
|
47
|
+
{
|
48
|
+
:'first_name' => :'String',
|
49
|
+
:'last_name' => :'String',
|
50
|
+
:'id' => :'String',
|
51
|
+
:'work_email' => :'String',
|
52
|
+
:'remote_id' => :'String'
|
53
|
+
}
|
54
|
+
end
|
55
|
+
|
56
|
+
# List of attributes with nullable: true
|
57
|
+
def self.openapi_nullable
|
58
|
+
Set.new([
|
59
|
+
:'first_name',
|
60
|
+
:'last_name',
|
61
|
+
:'id',
|
62
|
+
:'work_email',
|
63
|
+
:'remote_id'
|
64
|
+
])
|
65
|
+
end
|
66
|
+
|
67
|
+
# Initializes the object
|
68
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
69
|
+
def initialize(attributes = {})
|
70
|
+
if (!attributes.is_a?(Hash))
|
71
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EmployeeResponseManager` initialize method"
|
72
|
+
end
|
73
|
+
|
74
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
75
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
76
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
77
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EmployeeResponseManager`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
78
|
+
end
|
79
|
+
h[k.to_sym] = v
|
80
|
+
}
|
81
|
+
|
82
|
+
if attributes.key?(:'first_name')
|
83
|
+
self.first_name = attributes[:'first_name']
|
84
|
+
end
|
85
|
+
|
86
|
+
if attributes.key?(:'last_name')
|
87
|
+
self.last_name = attributes[:'last_name']
|
88
|
+
end
|
89
|
+
|
90
|
+
if attributes.key?(:'id')
|
91
|
+
self.id = attributes[:'id']
|
92
|
+
end
|
93
|
+
|
94
|
+
if attributes.key?(:'work_email')
|
95
|
+
self.work_email = attributes[:'work_email']
|
96
|
+
end
|
97
|
+
|
98
|
+
if attributes.key?(:'remote_id')
|
99
|
+
self.remote_id = attributes[:'remote_id']
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
104
|
+
# @return Array for valid properties with the reasons
|
105
|
+
def list_invalid_properties
|
106
|
+
invalid_properties = Array.new
|
107
|
+
invalid_properties
|
108
|
+
end
|
109
|
+
|
110
|
+
# Check to see if the all the properties in the model are valid
|
111
|
+
# @return true if the model is valid
|
112
|
+
def valid?
|
113
|
+
true
|
114
|
+
end
|
115
|
+
|
116
|
+
# Checks equality by comparing each attribute.
|
117
|
+
# @param [Object] Object to be compared
|
118
|
+
def ==(o)
|
119
|
+
return true if self.equal?(o)
|
120
|
+
self.class == o.class &&
|
121
|
+
first_name == o.first_name &&
|
122
|
+
last_name == o.last_name &&
|
123
|
+
id == o.id &&
|
124
|
+
work_email == o.work_email &&
|
125
|
+
remote_id == o.remote_id
|
126
|
+
end
|
127
|
+
|
128
|
+
# @see the `==` method
|
129
|
+
# @param [Object] Object to be compared
|
130
|
+
def eql?(o)
|
131
|
+
self == o
|
132
|
+
end
|
133
|
+
|
134
|
+
# Calculates hash code according to all attributes.
|
135
|
+
# @return [Integer] Hash code
|
136
|
+
def hash
|
137
|
+
[first_name, last_name, id, work_email, remote_id].hash
|
138
|
+
end
|
139
|
+
|
140
|
+
# Builds the object from hash
|
141
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
142
|
+
# @return [Object] Returns the model itself
|
143
|
+
def self.build_from_hash(attributes)
|
144
|
+
new.build_from_hash(attributes)
|
145
|
+
end
|
146
|
+
|
147
|
+
# Builds the object from hash
|
148
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
149
|
+
# @return [Object] Returns the model itself
|
150
|
+
def build_from_hash(attributes)
|
151
|
+
return nil unless attributes.is_a?(Hash)
|
152
|
+
self.class.openapi_types.each_pair do |key, type|
|
153
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
154
|
+
self.send("#{key}=", nil)
|
155
|
+
elsif type =~ /\AArray<(.*)>/i
|
156
|
+
# check to ensure the input is an array given that the attribute
|
157
|
+
# is documented as an array but the input is not
|
158
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
159
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
160
|
+
end
|
161
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
162
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
self
|
167
|
+
end
|
168
|
+
|
169
|
+
# Deserializes the data based on type
|
170
|
+
# @param string type Data type
|
171
|
+
# @param string value Value to be deserialized
|
172
|
+
# @return [Object] Deserialized data
|
173
|
+
def _deserialize(type, value)
|
174
|
+
case type.to_sym
|
175
|
+
when :Time
|
176
|
+
Time.parse(value)
|
177
|
+
when :Date
|
178
|
+
Date.parse(value)
|
179
|
+
when :String
|
180
|
+
value.to_s
|
181
|
+
when :Integer
|
182
|
+
value.to_i
|
183
|
+
when :Float
|
184
|
+
value.to_f
|
185
|
+
when :Boolean
|
186
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
187
|
+
true
|
188
|
+
else
|
189
|
+
false
|
190
|
+
end
|
191
|
+
when :Object
|
192
|
+
# generic object (usually a Hash), return directly
|
193
|
+
value
|
194
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
195
|
+
inner_type = Regexp.last_match[:inner_type]
|
196
|
+
value.map { |v| _deserialize(inner_type, v) }
|
197
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
198
|
+
k_type = Regexp.last_match[:k_type]
|
199
|
+
v_type = Regexp.last_match[:v_type]
|
200
|
+
{}.tap do |hash|
|
201
|
+
value.each do |k, v|
|
202
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
203
|
+
end
|
204
|
+
end
|
205
|
+
else # model
|
206
|
+
# models (e.g. Pet) or oneOf
|
207
|
+
klass = OpenapiClient.const_get(type)
|
208
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
209
|
+
end
|
210
|
+
end
|
211
|
+
|
212
|
+
# Returns the string representation of the object
|
213
|
+
# @return [String] String presentation of the object
|
214
|
+
def to_s
|
215
|
+
to_hash.to_s
|
216
|
+
end
|
217
|
+
|
218
|
+
# to_body is an alias to to_hash (backward compatibility)
|
219
|
+
# @return [Hash] Returns the object in the form of hash
|
220
|
+
def to_body
|
221
|
+
to_hash
|
222
|
+
end
|
223
|
+
|
224
|
+
# Returns the object in the form of hash
|
225
|
+
# @return [Hash] Returns the object in the form of hash
|
226
|
+
def to_hash
|
227
|
+
hash = {}
|
228
|
+
self.class.attribute_map.each_pair do |attr, param|
|
229
|
+
value = self.send(attr)
|
230
|
+
if value.nil?
|
231
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
232
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
233
|
+
end
|
234
|
+
|
235
|
+
hash[param] = _to_hash(value)
|
236
|
+
end
|
237
|
+
hash
|
238
|
+
end
|
239
|
+
|
240
|
+
# Outputs non-array value in the form of hash
|
241
|
+
# For object, use to_hash. Otherwise, just return the value
|
242
|
+
# @param [Object] value Any valid value
|
243
|
+
# @return [Hash] Returns the value in the form of hash
|
244
|
+
def _to_hash(value)
|
245
|
+
if value.is_a?(Array)
|
246
|
+
value.compact.map { |v| _to_hash(v) }
|
247
|
+
elsif value.is_a?(Hash)
|
248
|
+
{}.tap do |hash|
|
249
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
250
|
+
end
|
251
|
+
elsif value.respond_to? :to_hash
|
252
|
+
value.to_hash
|
253
|
+
else
|
254
|
+
value
|
255
|
+
end
|
256
|
+
end
|
257
|
+
|
258
|
+
end
|
259
|
+
|
260
|
+
end
|
@@ -90,6 +90,7 @@ module OpenapiClient
|
|
90
90
|
:'pay_period',
|
91
91
|
:'pay_frequency',
|
92
92
|
:'employment_type',
|
93
|
+
:'currency',
|
93
94
|
:'effective_date'
|
94
95
|
])
|
95
96
|
end
|
@@ -142,10 +143,6 @@ module OpenapiClient
|
|
142
143
|
# @return Array for valid properties with the reasons
|
143
144
|
def list_invalid_properties
|
144
145
|
invalid_properties = Array.new
|
145
|
-
if @currency.nil?
|
146
|
-
invalid_properties.push('invalid value for "currency", currency cannot be nil.')
|
147
|
-
end
|
148
|
-
|
149
146
|
invalid_properties
|
150
147
|
end
|
151
148
|
|
@@ -156,7 +153,6 @@ module OpenapiClient
|
|
156
153
|
return false unless pay_frequency_validator.valid?(@pay_frequency)
|
157
154
|
employment_type_validator = EnumAttributeValidator.new('String', ["full_time", "part_time", "contractor", "other"])
|
158
155
|
return false unless employment_type_validator.valid?(@employment_type)
|
159
|
-
return false if @currency.nil?
|
160
156
|
true
|
161
157
|
end
|
162
158
|
|
data/lib/openapi_client.rb
CHANGED
@@ -29,6 +29,7 @@ require 'openapi_client/models/currency_not_null_request'
|
|
29
29
|
require 'openapi_client/models/currency_response'
|
30
30
|
require 'openapi_client/models/disconnect_response'
|
31
31
|
require 'openapi_client/models/employee_response'
|
32
|
+
require 'openapi_client/models/employee_response_manager'
|
32
33
|
require 'openapi_client/models/employment_no_null_enum_request'
|
33
34
|
require 'openapi_client/models/employment_response'
|
34
35
|
require 'openapi_client/models/group_no_null_enum_request'
|
@@ -46,7 +46,7 @@ describe OpenapiClient::AddressNoNonNullRequest do
|
|
46
46
|
describe 'test attribute "country"' do
|
47
47
|
it 'should work' do
|
48
48
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["AT", "BE", "CA", "CH", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PL", "RO", "SE", "SG", "SK", "US"])
|
49
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["AT", "AU", "BE", "CA", "CH", "CN", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "HK", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PH", "PL", "RO", "SE", "SG", "SK", "TW", "US"])
|
50
50
|
# validator.allowable_values.each do |value|
|
51
51
|
# expect { instance.country = value }.not_to raise_error
|
52
52
|
# end
|
@@ -46,7 +46,7 @@ describe OpenapiClient::AddressResponse do
|
|
46
46
|
describe 'test attribute "country"' do
|
47
47
|
it 'should work' do
|
48
48
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["null", "AT", "AU", "BE", "CA", "CH", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PL", "RO", "SE", "SG", "SK", "US"])
|
49
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["null", "AT", "AU", "BE", "CA", "CH", "CN", "CZ", "DE", "DK", "EE", "ES", "FR", "GB", "HK", "IE", "IT", "JP", "LT", "LV", "NL", "NO", "PH", "PL", "RO", "SE", "SG", "SK", "TW", "US"])
|
50
50
|
# validator.allowable_values.each do |value|
|
51
51
|
# expect { instance.country = value }.not_to raise_error
|
52
52
|
# end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
=begin
|
2
|
+
#Affix API
|
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 (xhr mode) ### dev ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q' \\ 'https://dev.api.affixapi.com/2023-03-01/xhr/employees' ``` ### prod ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg' \\ '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
|
+
|
6
|
+
The version of the OpenAPI document: 2023-03-01
|
7
|
+
Contact: developers@affixapi.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for OpenapiClient::EmployeeResponseManager
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe OpenapiClient::EmployeeResponseManager do
|
21
|
+
let(:instance) { OpenapiClient::EmployeeResponseManager.new }
|
22
|
+
|
23
|
+
describe 'test an instance of EmployeeResponseManager' do
|
24
|
+
it 'should create an instance of EmployeeResponseManager' do
|
25
|
+
expect(instance).to be_instance_of(OpenapiClient::EmployeeResponseManager)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
describe 'test attribute "first_name"' do
|
29
|
+
it 'should work' do
|
30
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
describe 'test attribute "last_name"' do
|
35
|
+
it 'should work' do
|
36
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
describe 'test attribute "id"' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
describe 'test attribute "work_email"' do
|
47
|
+
it 'should work' do
|
48
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
describe 'test attribute "remote_id"' do
|
53
|
+
it 'should work' do
|
54
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: affixapi
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.51
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenAPI-Generator
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-04-
|
11
|
+
date: 2024-04-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -136,6 +136,7 @@ files:
|
|
136
136
|
- docs/CurrencyResponse.md
|
137
137
|
- docs/DisconnectResponse.md
|
138
138
|
- docs/EmployeeResponse.md
|
139
|
+
- docs/EmployeeResponseManager.md
|
139
140
|
- docs/EmploymentNoNullEnumRequest.md
|
140
141
|
- docs/EmploymentResponse.md
|
141
142
|
- docs/GroupNoNullEnumRequest.md
|
@@ -189,6 +190,7 @@ files:
|
|
189
190
|
- lib/openapi_client/models/currency_response.rb
|
190
191
|
- lib/openapi_client/models/disconnect_response.rb
|
191
192
|
- lib/openapi_client/models/employee_response.rb
|
193
|
+
- lib/openapi_client/models/employee_response_manager.rb
|
192
194
|
- lib/openapi_client/models/employment_no_null_enum_request.rb
|
193
195
|
- lib/openapi_client/models/employment_response.rb
|
194
196
|
- lib/openapi_client/models/group_no_null_enum_request.rb
|
@@ -237,6 +239,7 @@ files:
|
|
237
239
|
- spec/models/currency_not_null_request_spec.rb
|
238
240
|
- spec/models/currency_response_spec.rb
|
239
241
|
- spec/models/disconnect_response_spec.rb
|
242
|
+
- spec/models/employee_response_manager_spec.rb
|
240
243
|
- spec/models/employee_response_spec.rb
|
241
244
|
- spec/models/employment_no_null_enum_request_spec.rb
|
242
245
|
- spec/models/employment_response_spec.rb
|
@@ -2751,52 +2754,53 @@ signing_key:
|
|
2751
2754
|
specification_version: 4
|
2752
2755
|
summary: Affix API Ruby Gem
|
2753
2756
|
test_files:
|
2754
|
-
- spec/api/management_api_spec.rb
|
2755
|
-
- spec/api/xhr_vertically_integrated_api_spec.rb
|
2756
|
-
- spec/api/class20230301_api_spec.rb
|
2757
2757
|
- spec/api/core_api_spec.rb
|
2758
|
+
- spec/api/class20230301_api_spec.rb
|
2759
|
+
- spec/api/xhr_vertically_integrated_api_spec.rb
|
2760
|
+
- spec/api/management_api_spec.rb
|
2758
2761
|
- spec/api_client_spec.rb
|
2759
2762
|
- spec/configuration_spec.rb
|
2760
|
-
- spec/models/
|
2761
|
-
- spec/models/mode_response_spec.rb
|
2763
|
+
- spec/models/disconnect_response_spec.rb
|
2762
2764
|
- spec/models/provider_response_spec.rb
|
2763
|
-
- spec/models/
|
2764
|
-
- spec/models/payrun_response_spec.rb
|
2765
|
-
- spec/models/location_response_spec.rb
|
2766
|
-
- spec/models/payslip_response_spec.rb
|
2767
|
-
- spec/models/inline_response400_spec.rb
|
2765
|
+
- spec/models/mode_response_spec.rb
|
2768
2766
|
- spec/models/create_employee_request_bank_account_spec.rb
|
2767
|
+
- spec/models/id_and_message_response_spec.rb
|
2768
|
+
- spec/models/message_response_spec.rb
|
2769
|
+
- spec/models/timesheet_response_spec.rb
|
2770
|
+
- spec/models/create_employee_request_manager_spec.rb
|
2771
|
+
- spec/models/client_request_spec.rb
|
2772
|
+
- spec/models/identity_response_spec.rb
|
2769
2773
|
- spec/models/scopes_response_spec.rb
|
2770
|
-
- spec/models/
|
2774
|
+
- spec/models/mode_request_spec.rb
|
2771
2775
|
- spec/models/group_no_null_enum_request_spec.rb
|
2772
|
-
- spec/models/time_off_entry_response_spec.rb
|
2773
|
-
- spec/models/provider_request_spec.rb
|
2774
2776
|
- spec/models/payslip_response_contributions_spec.rb
|
2775
|
-
- spec/models/
|
2776
|
-
- spec/models/
|
2777
|
-
- spec/models/time_off_balance_response_spec.rb
|
2778
|
-
- spec/models/client_request_spec.rb
|
2779
|
-
- spec/models/token_response_spec.rb
|
2780
|
-
- spec/models/group_response_spec.rb
|
2781
|
-
- spec/models/payslip_response_deductions_spec.rb
|
2782
|
-
- spec/models/create_employee_request_manager_spec.rb
|
2777
|
+
- spec/models/employment_no_null_enum_request_spec.rb
|
2778
|
+
- spec/models/payslip_response_earnings_spec.rb
|
2783
2779
|
- spec/models/employee_response_spec.rb
|
2784
|
-
- spec/models/
|
2785
|
-
- spec/models/
|
2780
|
+
- spec/models/currency_response_spec.rb
|
2781
|
+
- spec/models/currency_not_null_request_spec.rb
|
2782
|
+
- spec/models/address_response_spec.rb
|
2783
|
+
- spec/models/scopes_request_spec.rb
|
2784
|
+
- spec/models/provider_request_spec.rb
|
2785
|
+
- spec/models/location_response_spec.rb
|
2786
2786
|
- spec/models/location_no_non_null_request_spec.rb
|
2787
|
-
- spec/models/
|
2787
|
+
- spec/models/inline_response401_spec.rb
|
2788
2788
|
- spec/models/address_no_non_null_request_spec.rb
|
2789
|
+
- spec/models/time_off_balance_response_spec.rb
|
2790
|
+
- spec/models/inline_response400_spec.rb
|
2791
|
+
- spec/models/company_response_spec.rb
|
2792
|
+
- spec/models/payslip_response_spec.rb
|
2793
|
+
- spec/models/create_employee_request_spec.rb
|
2789
2794
|
- spec/models/inline_response409_spec.rb
|
2790
|
-
- spec/models/client_response_spec.rb
|
2791
2795
|
- spec/models/introspect_response_spec.rb
|
2796
|
+
- spec/models/token_response_spec.rb
|
2797
|
+
- spec/models/payslip_response_deductions_spec.rb
|
2792
2798
|
- spec/models/employment_response_spec.rb
|
2793
|
-
- spec/models/
|
2794
|
-
- spec/models/
|
2795
|
-
- spec/models/
|
2796
|
-
- spec/models/
|
2797
|
-
- spec/models/
|
2798
|
-
- spec/models/
|
2799
|
-
- spec/models/
|
2800
|
-
- spec/models/mode_request_spec.rb
|
2801
|
-
- spec/models/disconnect_response_spec.rb
|
2799
|
+
- spec/models/payrun_response_spec.rb
|
2800
|
+
- spec/models/time_off_entry_response_spec.rb
|
2801
|
+
- spec/models/client_response_spec.rb
|
2802
|
+
- spec/models/group_response_spec.rb
|
2803
|
+
- spec/models/payslip_response_taxes_spec.rb
|
2804
|
+
- spec/models/token_request_spec.rb
|
2805
|
+
- spec/models/employee_response_manager_spec.rb
|
2802
2806
|
- spec/spec_helper.rb
|