affixapi 1.1.62 → 1.1.63

Sign up to get free protection for your applications and to get access to all the features.
Files changed (18) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +1 -2
  4. data/docs/Class20230301Api.md +2 -2
  5. data/docs/{EmploymentStatus.md → EmploymentStatusNotNullNotNullable.md} +2 -2
  6. data/docs/XHRVerticallyIntegratedApi.md +2 -2
  7. data/lib/openapi_client/api/class20230301_api.rb +2 -2
  8. data/lib/openapi_client/api/xhr_vertically_integrated_api.rb +2 -2
  9. data/lib/openapi_client/models/{employment_status.rb → employment_status_not_null_not_nullable.rb} +3 -4
  10. data/lib/openapi_client/version.rb +1 -1
  11. data/lib/openapi_client.rb +1 -2
  12. data/spec/api/class20230301_api_spec.rb +1 -1
  13. data/spec/api/xhr_vertically_integrated_api_spec.rb +1 -1
  14. data/spec/models/{employment_status_not_null_spec.rb → employment_status_not_null_not_nullable_spec.rb} +6 -6
  15. metadata +5 -9
  16. data/docs/EmploymentStatusNotNull.md +0 -15
  17. data/lib/openapi_client/models/employment_status_not_null.rb +0 -39
  18. data/spec/models/employment_status_spec.rb +0 -28
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 58895b146e59798b8d0cf9b68be490bda1612804db6ed02aa410973741046e1f
4
- data.tar.gz: 5e913bcd3c7073d0b6150e0e6c13c42f2815f69fb5d5b49f91cf48aea2bd5060
3
+ metadata.gz: b9b435e32a2cc256dadd3594b11fa0eedee64749ea3dfe243e54a1b54a1c73ce
4
+ data.tar.gz: ef2ee5e95e10108715439f0b434a635377060e732931ae72d7bd1ab059ccb407
5
5
  SHA512:
6
- metadata.gz: 2fc93c9dfe174b5664d3fee39779f78ef6c51a08d75a62d5bb65e359ec877f0f69ab769aca33829507bbdca5c464a26be51a045e352bd70bf56a8e372b0037af
7
- data.tar.gz: 2d356bb1c1c5e5b52eb518603ad0f70a4a6eb369eba6b7dd75efa5407e503e62b9748aa0a13c76da63c00bc0417c18c4be9e9adbdae40a48305f31ef9e7835a6
6
+ metadata.gz: 417166b6285e0a726e24d8952333d6b3a58f108b3451d4f61cd11c110328f479a154b8afa2debd56515df9596df75496fcfee40155d495419f4a80458c57470e
7
+ data.tar.gz: ce0f06e725c57989bf0dd7b4b86a098cfef2f9d1de89eb5ca3cfccb13f7f41ee066856c030cea52aa0ae1e2ca6c61b88b825a4d9ac8813940d5e2f6ebe230499
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- affixapi (1.1.62)
4
+ affixapi (1.1.63)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -336,8 +336,7 @@ Class | Method | HTTP request | Description
336
336
  - [OpenapiClient::EmployeeResponseManager](docs/EmployeeResponseManager.md)
337
337
  - [OpenapiClient::EmploymentNoNullEnumRequest](docs/EmploymentNoNullEnumRequest.md)
338
338
  - [OpenapiClient::EmploymentResponse](docs/EmploymentResponse.md)
339
- - [OpenapiClient::EmploymentStatus](docs/EmploymentStatus.md)
340
- - [OpenapiClient::EmploymentStatusNotNull](docs/EmploymentStatusNotNull.md)
339
+ - [OpenapiClient::EmploymentStatusNotNullNotNullable](docs/EmploymentStatusNotNullNotNullable.md)
341
340
  - [OpenapiClient::EmploymentStatusNotNullRequest](docs/EmploymentStatusNotNullRequest.md)
342
341
  - [OpenapiClient::EmploymentStatusResponse](docs/EmploymentStatusResponse.md)
343
342
  - [OpenapiClient::GroupNoNullEnumRequest](docs/GroupNoNullEnumRequest.md)
data/docs/Class20230301Api.md CHANGED
@@ -107,7 +107,7 @@ end
107
107
 
108
108
  api_instance = OpenapiClient::Class20230301Api.new
109
109
  opts = {
110
- employment_status: OpenapiClient::EmploymentStatusNotNull::ACTIVE # EmploymentStatusNotNull | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)
110
+ employment_status: OpenapiClient::EmploymentStatusNotNullNotNullable::ACTIVE # EmploymentStatusNotNullNotNullable | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)
111
111
  }
112
112
 
113
113
  begin
@@ -141,7 +141,7 @@ end
141
141
 
142
142
  | Name | Type | Description | Notes |
143
143
  | ---- | ---- | ----------- | ----- |
144
- | **employment_status** | [**EmploymentStatusNotNull**](.md) | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) | [optional] |
144
+ | **employment_status** | [**EmploymentStatusNotNullNotNullable**](.md) | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) | [optional] |
145
145
 
146
146
  ### Return type
147
147
 
data/docs/{EmploymentStatus.md → EmploymentStatusNotNullNotNullable.md} RENAMED
@@ -1,4 +1,4 @@
1
- # OpenapiClient::EmploymentStatus
1
+ # OpenapiClient::EmploymentStatusNotNullNotNullable
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,6 +10,6 @@
10
10
  ```ruby
11
11
  require 'openapi_client'
12
12
 
13
- instance = OpenapiClient::EmploymentStatus.new()
13
+ instance = OpenapiClient::EmploymentStatusNotNullNotNullable.new()
14
14
  ```
15
15
 
data/docs/XHRVerticallyIntegratedApi.md CHANGED
@@ -107,7 +107,7 @@ end
107
107
 
108
108
  api_instance = OpenapiClient::XHRVerticallyIntegratedApi.new
109
109
  opts = {
110
- employment_status: OpenapiClient::EmploymentStatusNotNull::ACTIVE # EmploymentStatusNotNull | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)
110
+ employment_status: OpenapiClient::EmploymentStatusNotNullNotNullable::ACTIVE # EmploymentStatusNotNullNotNullable | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)
111
111
  }
112
112
 
113
113
  begin
@@ -141,7 +141,7 @@ end
141
141
 
142
142
  | Name | Type | Description | Notes |
143
143
  | ---- | ---- | ----------- | ----- |
144
- | **employment_status** | [**EmploymentStatusNotNull**](.md) | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) | [optional] |
144
+ | **employment_status** | [**EmploymentStatusNotNullNotNullable**](.md) | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) | [optional] |
145
145
 
146
146
  ### Return type
147
147
 
data/lib/openapi_client/api/class20230301_api.rb CHANGED
@@ -79,7 +79,7 @@ module OpenapiClient
79
79
  # Employees
80
80
  # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
81
81
  # @param [Hash] opts the optional parameters
82
- # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)
82
+ # @option opts [EmploymentStatusNotNullNotNullable] :employment_status Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)
83
83
  # @return [Array<EmployeeResponse>]
84
84
  def xhr_employees20230301(opts = {})
85
85
  data, _status_code, _headers = xhr_employees20230301_with_http_info(opts)
@@ -89,7 +89,7 @@ module OpenapiClient
89
89
  # Employees
90
90
  # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
91
91
  # @param [Hash] opts the optional parameters
92
- # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
92
+ # @option opts [EmploymentStatusNotNullNotNullable] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
93
93
  # @return [Array<(Array<EmployeeResponse>, Integer, Hash)>] Array<EmployeeResponse> data, response status code and response headers
94
94
  def xhr_employees20230301_with_http_info(opts = {})
95
95
  if @api_client.config.debugging
data/lib/openapi_client/api/xhr_vertically_integrated_api.rb CHANGED
@@ -79,7 +79,7 @@ module OpenapiClient
79
79
  # Employees
80
80
  # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
81
81
  # @param [Hash] opts the optional parameters
82
- # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
82
+ # @option opts [EmploymentStatusNotNullNotNullable] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
83
83
  # @return [Array<EmployeeResponse>]
84
84
  def xhr_employees20230301(opts = {})
85
85
  data, _status_code, _headers = xhr_employees20230301_with_http_info(opts)
@@ -89,7 +89,7 @@ module OpenapiClient
89
89
  # Employees
90
90
  # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
91
91
  # @param [Hash] opts the optional parameters
92
- # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
92
+ # @option opts [EmploymentStatusNotNullNotNullable] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
93
93
  # @return [Array<(Array<EmployeeResponse>, Integer, Hash)>] Array<EmployeeResponse> data, response status code and response headers
94
94
  def xhr_employees20230301_with_http_info(opts = {})
95
95
  if @api_client.config.debugging
data/lib/openapi_client/models/{employment_status.rb → employment_status_not_null_not_nullable.rb} RENAMED
@@ -14,8 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module OpenapiClient
17
- class EmploymentStatus
18
- NULL = "null".freeze
17
+ class EmploymentStatusNotNullNotNullable
19
18
  ACTIVE = "active".freeze
20
19
  INACTIVE = "inactive".freeze
21
20
  PENDING = "pending".freeze
@@ -32,8 +31,8 @@ module OpenapiClient
32
31
  # @param [String] The enum value in the form of the string
33
32
  # @return [String] The enum value
34
33
  def build_from_hash(value)
35
- constantValues = EmploymentStatus.constants.select { |c| EmploymentStatus::const_get(c) == value }
36
- raise "Invalid ENUM value #{value} for class #EmploymentStatus" if constantValues.empty?
34
+ constantValues = EmploymentStatusNotNullNotNullable.constants.select { |c| EmploymentStatusNotNullNotNullable::const_get(c) == value }
35
+ raise "Invalid ENUM value #{value} for class #EmploymentStatusNotNullNotNullable" if constantValues.empty?
37
36
  value
38
37
  end
39
38
  end
data/lib/openapi_client/version.rb CHANGED
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.1.1
11
11
  =end
12
12
 
13
13
  module OpenapiClient
14
- VERSION = '1.1.62'
14
+ VERSION = '1.1.63'
15
15
  end
data/lib/openapi_client.rb CHANGED
@@ -34,8 +34,7 @@ require 'openapi_client/models/employee_response'
34
34
  require 'openapi_client/models/employee_response_manager'
35
35
  require 'openapi_client/models/employment_no_null_enum_request'
36
36
  require 'openapi_client/models/employment_response'
37
- require 'openapi_client/models/employment_status'
38
- require 'openapi_client/models/employment_status_not_null'
37
+ require 'openapi_client/models/employment_status_not_null_not_nullable'
39
38
  require 'openapi_client/models/employment_status_not_null_request'
40
39
  require 'openapi_client/models/employment_status_response'
41
40
  require 'openapi_client/models/group_no_null_enum_request'
data/spec/api/class20230301_api_spec.rb CHANGED
@@ -47,7 +47,7 @@ describe 'Class20230301Api' do
47
47
  # Employees
48
48
  # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
49
49
  # @param [Hash] opts the optional parameters
50
- # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
50
+ # @option opts [EmploymentStatusNotNullNotNullable] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
51
51
  # @return [Array<EmployeeResponse>]
52
52
  describe 'xhr_employees20230301 test' do
53
53
  it 'should work' do
data/spec/api/xhr_vertically_integrated_api_spec.rb CHANGED
@@ -47,7 +47,7 @@ describe 'XHRVerticallyIntegratedApi' do
47
47
  # Employees
48
48
  # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software
49
49
  # @param [Hash] opts the optional parameters
50
- # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
50
+ # @option opts [EmploymentStatusNotNullNotNullable] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)
51
51
  # @return [Array<EmployeeResponse>]
52
52
  describe 'xhr_employees20230301 test' do
53
53
  it 'should work' do
data/spec/models/{employment_status_not_null_spec.rb → employment_status_not_null_not_nullable_spec.rb} RENAMED
@@ -14,15 +14,15 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for OpenapiClient::EmploymentStatusNotNull
17
+ # Unit tests for OpenapiClient::EmploymentStatusNotNullNotNullable
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe OpenapiClient::EmploymentStatusNotNull do
21
- let(:instance) { OpenapiClient::EmploymentStatusNotNull.new }
20
+ describe OpenapiClient::EmploymentStatusNotNullNotNullable do
21
+ let(:instance) { OpenapiClient::EmploymentStatusNotNullNotNullable.new }
22
22
 
23
- describe 'test an instance of EmploymentStatusNotNull' do
24
- it 'should create an instance of EmploymentStatusNotNull' do
25
- expect(instance).to be_instance_of(OpenapiClient::EmploymentStatusNotNull)
23
+ describe 'test an instance of EmploymentStatusNotNullNotNullable' do
24
+ it 'should create an instance of EmploymentStatusNotNullNotNullable' do
25
+ expect(instance).to be_instance_of(OpenapiClient::EmploymentStatusNotNullNotNullable)
26
26
  end
27
27
  end
28
28
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: affixapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.62
4
+ version: 1.1.63
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
@@ -141,8 +141,7 @@ files:
141
141
  - docs/EmployeeResponseManager.md
142
142
  - docs/EmploymentNoNullEnumRequest.md
143
143
  - docs/EmploymentResponse.md
144
- - docs/EmploymentStatus.md
145
- - docs/EmploymentStatusNotNull.md
144
+ - docs/EmploymentStatusNotNullNotNullable.md
146
145
  - docs/EmploymentStatusNotNullRequest.md
147
146
  - docs/EmploymentStatusResponse.md
148
147
  - docs/GroupNoNullEnumRequest.md
@@ -201,8 +200,7 @@ files:
201
200
  - lib/openapi_client/models/employee_response_manager.rb
202
201
  - lib/openapi_client/models/employment_no_null_enum_request.rb
203
202
  - lib/openapi_client/models/employment_response.rb
204
- - lib/openapi_client/models/employment_status.rb
205
- - lib/openapi_client/models/employment_status_not_null.rb
203
+ - lib/openapi_client/models/employment_status_not_null_not_nullable.rb
206
204
  - lib/openapi_client/models/employment_status_not_null_request.rb
207
205
  - lib/openapi_client/models/employment_status_response.rb
208
206
  - lib/openapi_client/models/group_no_null_enum_request.rb
@@ -257,10 +255,9 @@ files:
257
255
  - spec/models/employee_response_spec.rb
258
256
  - spec/models/employment_no_null_enum_request_spec.rb
259
257
  - spec/models/employment_response_spec.rb
258
+ - spec/models/employment_status_not_null_not_nullable_spec.rb
260
259
  - spec/models/employment_status_not_null_request_spec.rb
261
- - spec/models/employment_status_not_null_spec.rb
262
260
  - spec/models/employment_status_response_spec.rb
263
- - spec/models/employment_status_spec.rb
264
261
  - spec/models/group_no_null_enum_request_spec.rb
265
262
  - spec/models/group_response_spec.rb
266
263
  - spec/models/id_and_message_response_spec.rb
@@ -2780,7 +2777,6 @@ test_files:
2780
2777
  - spec/configuration_spec.rb
2781
2778
  - spec/models/payslip_response_contributions_spec.rb
2782
2779
  - spec/models/id_and_message_response_spec.rb
2783
- - spec/models/employment_status_spec.rb
2784
2780
  - spec/models/location_response_spec.rb
2785
2781
  - spec/models/mode_request_spec.rb
2786
2782
  - spec/models/group_no_null_enum_request_spec.rb
@@ -2815,13 +2811,13 @@ test_files:
2815
2811
  - spec/models/disconnect_response_spec.rb
2816
2812
  - spec/models/employee_response_spec.rb
2817
2813
  - spec/models/inline_response409_spec.rb
2814
+ - spec/models/employment_status_not_null_not_nullable_spec.rb
2818
2815
  - spec/models/currency_response_spec.rb
2819
2816
  - spec/models/provider_request_spec.rb
2820
2817
  - spec/models/payslip_response_deductions_spec.rb
2821
2818
  - spec/models/token_request_spec.rb
2822
2819
  - spec/models/create_employee_request_emergency_contacts_spec.rb
2823
2820
  - spec/models/client_response_spec.rb
2824
- - spec/models/employment_status_not_null_spec.rb
2825
2821
  - spec/models/introspect_response_spec.rb
2826
2822
  - spec/models/mode_response_spec.rb
2827
2823
  - spec/models/scopes_request_spec.rb
data/docs/EmploymentStatusNotNull.md DELETED
@@ -1,15 +0,0 @@
1
- # OpenapiClient::EmploymentStatusNotNull
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'openapi_client'
12
-
13
- instance = OpenapiClient::EmploymentStatusNotNull.new()
14
- ```
15
-
data/lib/openapi_client/models/employment_status_not_null.rb DELETED
@@ -1,39 +0,0 @@
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 EmploymentStatusNotNull
18
- ACTIVE = "active".freeze
19
- INACTIVE = "inactive".freeze
20
- PENDING = "pending".freeze
21
- LEAVE = "leave".freeze
22
-
23
- # Builds the enum from string
24
- # @param [String] The enum value in the form of the string
25
- # @return [String] The enum value
26
- def self.build_from_hash(value)
27
- new.build_from_hash(value)
28
- end
29
-
30
- # Builds the enum from string
31
- # @param [String] The enum value in the form of the string
32
- # @return [String] The enum value
33
- def build_from_hash(value)
34
- constantValues = EmploymentStatusNotNull.constants.select { |c| EmploymentStatusNotNull::const_get(c) == value }
35
- raise "Invalid ENUM value #{value} for class #EmploymentStatusNotNull" if constantValues.empty?
36
- value
37
- end
38
- end
39
- end
data/spec/models/employment_status_spec.rb DELETED
@@ -1,28 +0,0 @@
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::EmploymentStatus
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe OpenapiClient::EmploymentStatus do
21
- let(:instance) { OpenapiClient::EmploymentStatus.new }
22
-
23
- describe 'test an instance of EmploymentStatus' do
24
- it 'should create an instance of EmploymentStatus' do
25
- expect(instance).to be_instance_of(OpenapiClient::EmploymentStatus)
26
- end
27
- end
28
- end