affixapi 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (159) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +19 -0
  4. data/README.md +374 -0
  5. data/Rakefile +10 -0
  6. data/affixapi.gemspec +38 -0
  7. data/docs/AddressNoNonNullRequest.md +26 -0
  8. data/docs/AddressResponse.md +26 -0
  9. data/docs/Class20230301Api.md +1401 -0
  10. data/docs/ClientRequest.md +24 -0
  11. data/docs/ClientResponse.md +26 -0
  12. data/docs/CompanyResponse.md +28 -0
  13. data/docs/CoreApi.md +69 -0
  14. data/docs/CreateEmployeeRequest.md +68 -0
  15. data/docs/CreateEmployeeRequestBankAccount.md +26 -0
  16. data/docs/CreateEmployeeRequestManager.md +26 -0
  17. data/docs/CurrencyRequest.md +15 -0
  18. data/docs/CurrencyResponse.md +15 -0
  19. data/docs/DeveloperApi.md +777 -0
  20. data/docs/DisconnectResponse.md +18 -0
  21. data/docs/EmployeeResponse.md +74 -0
  22. data/docs/EmploymentNoNullEnumRequest.md +30 -0
  23. data/docs/EmploymentResponse.md +30 -0
  24. data/docs/GroupNoNullEnumRequest.md +24 -0
  25. data/docs/GroupResponse.md +24 -0
  26. data/docs/IdAndMessageResponse.md +20 -0
  27. data/docs/IdentityResponse.md +22 -0
  28. data/docs/InlineResponse400.md +20 -0
  29. data/docs/InlineResponse401.md +22 -0
  30. data/docs/InlineResponse409.md +22 -0
  31. data/docs/IntrospectResponse.md +24 -0
  32. data/docs/LocationNoNonNullRequest.md +26 -0
  33. data/docs/LocationResponse.md +26 -0
  34. data/docs/ManagementApi.md +420 -0
  35. data/docs/MessageResponse.md +18 -0
  36. data/docs/ModeRequest.md +15 -0
  37. data/docs/ModeResponse.md +15 -0
  38. data/docs/OfficialApi.md +631 -0
  39. data/docs/PayrunResponse.md +30 -0
  40. data/docs/PayslipResponse.md +44 -0
  41. data/docs/PayslipResponseContributions.md +20 -0
  42. data/docs/PayslipResponseDeductions.md +20 -0
  43. data/docs/PayslipResponseEarnings.md +22 -0
  44. data/docs/PayslipResponseTaxes.md +22 -0
  45. data/docs/ProviderRequest.md +15 -0
  46. data/docs/ProviderResponse.md +15 -0
  47. data/docs/ScopesRequest.md +15 -0
  48. data/docs/ScopesResponse.md +15 -0
  49. data/docs/TimeOffBalanceResponse.md +32 -0
  50. data/docs/TimeOffEntryResponse.md +40 -0
  51. data/docs/TimesheetResponse.md +32 -0
  52. data/docs/TokenRequest.md +26 -0
  53. data/docs/TokenResponse.md +26 -0
  54. data/git_push.sh +58 -0
  55. data/lib/openapi_client/api/class20230301_api.rb +1198 -0
  56. data/lib/openapi_client/api/core_api.rb +79 -0
  57. data/lib/openapi_client/api/developer_api.rb +677 -0
  58. data/lib/openapi_client/api/management_api.rb +380 -0
  59. data/lib/openapi_client/api/official_api.rb +543 -0
  60. data/lib/openapi_client/api_client.rb +390 -0
  61. data/lib/openapi_client/api_error.rb +57 -0
  62. data/lib/openapi_client/configuration.rb +288 -0
  63. data/lib/openapi_client/models/address_no_non_null_request.rb +295 -0
  64. data/lib/openapi_client/models/address_response.rb +295 -0
  65. data/lib/openapi_client/models/client_request.rb +269 -0
  66. data/lib/openapi_client/models/client_response.rb +284 -0
  67. data/lib/openapi_client/models/company_response.rb +279 -0
  68. data/lib/openapi_client/models/create_employee_request.rb +568 -0
  69. data/lib/openapi_client/models/create_employee_request_bank_account.rb +259 -0
  70. data/lib/openapi_client/models/create_employee_request_manager.rb +263 -0
  71. data/lib/openapi_client/models/currency_request.rb +38 -0
  72. data/lib/openapi_client/models/currency_response.rb +38 -0
  73. data/lib/openapi_client/models/disconnect_response.rb +258 -0
  74. data/lib/openapi_client/models/employee_response.rb +608 -0
  75. data/lib/openapi_client/models/employment_no_null_enum_request.rb +329 -0
  76. data/lib/openapi_client/models/employment_response.rb +329 -0
  77. data/lib/openapi_client/models/group_no_null_enum_request.rb +283 -0
  78. data/lib/openapi_client/models/group_response.rb +283 -0
  79. data/lib/openapi_client/models/id_and_message_response.rb +239 -0
  80. data/lib/openapi_client/models/identity_response.rb +250 -0
  81. data/lib/openapi_client/models/inline_response400.rb +227 -0
  82. data/lib/openapi_client/models/inline_response401.rb +299 -0
  83. data/lib/openapi_client/models/inline_response409.rb +278 -0
  84. data/lib/openapi_client/models/introspect_response.rb +269 -0
  85. data/lib/openapi_client/models/location_no_non_null_request.rb +263 -0
  86. data/lib/openapi_client/models/location_response.rb +263 -0
  87. data/lib/openapi_client/models/message_response.rb +223 -0
  88. data/lib/openapi_client/models/mode_request.rb +37 -0
  89. data/lib/openapi_client/models/mode_response.rb +37 -0
  90. data/lib/openapi_client/models/payrun_response.rb +342 -0
  91. data/lib/openapi_client/models/payslip_response.rb +448 -0
  92. data/lib/openapi_client/models/payslip_response_contributions.rb +238 -0
  93. data/lib/openapi_client/models/payslip_response_deductions.rb +238 -0
  94. data/lib/openapi_client/models/payslip_response_earnings.rb +250 -0
  95. data/lib/openapi_client/models/payslip_response_taxes.rb +248 -0
  96. data/lib/openapi_client/models/provider_request.rb +70 -0
  97. data/lib/openapi_client/models/provider_response.rb +70 -0
  98. data/lib/openapi_client/models/scopes_request.rb +55 -0
  99. data/lib/openapi_client/models/scopes_response.rb +55 -0
  100. data/lib/openapi_client/models/time_off_balance_response.rb +342 -0
  101. data/lib/openapi_client/models/time_off_entry_response.rb +408 -0
  102. data/lib/openapi_client/models/timesheet_response.rb +318 -0
  103. data/lib/openapi_client/models/token_request.rb +318 -0
  104. data/lib/openapi_client/models/token_response.rb +318 -0
  105. data/lib/openapi_client/version.rb +15 -0
  106. data/lib/openapi_client.rb +86 -0
  107. data/openapi_client-0.0.1.gem +0 -0
  108. data/pkg/affixapi-0.0.1.gem +0 -0
  109. data/spec/api/class20230301_api_spec.rb +260 -0
  110. data/spec/api/core_api_spec.rb +46 -0
  111. data/spec/api/developer_api_spec.rb +160 -0
  112. data/spec/api/management_api_spec.rb +103 -0
  113. data/spec/api/official_api_spec.rb +135 -0
  114. data/spec/api_client_spec.rb +226 -0
  115. data/spec/configuration_spec.rb +42 -0
  116. data/spec/models/address_no_non_null_request_spec.rb +62 -0
  117. data/spec/models/address_response_spec.rb +62 -0
  118. data/spec/models/client_request_spec.rb +52 -0
  119. data/spec/models/client_response_spec.rb +58 -0
  120. data/spec/models/company_response_spec.rb +64 -0
  121. data/spec/models/create_employee_request_bank_account_spec.rb +58 -0
  122. data/spec/models/create_employee_request_manager_spec.rb +58 -0
  123. data/spec/models/create_employee_request_spec.rb +204 -0
  124. data/spec/models/currency_request_spec.rb +28 -0
  125. data/spec/models/currency_response_spec.rb +28 -0
  126. data/spec/models/disconnect_response_spec.rb +38 -0
  127. data/spec/models/employee_response_spec.rb +222 -0
  128. data/spec/models/employment_no_null_enum_request_spec.rb +78 -0
  129. data/spec/models/employment_response_spec.rb +78 -0
  130. data/spec/models/group_no_null_enum_request_spec.rb +56 -0
  131. data/spec/models/group_response_spec.rb +56 -0
  132. data/spec/models/id_and_message_response_spec.rb +40 -0
  133. data/spec/models/identity_response_spec.rb +46 -0
  134. data/spec/models/inline_response400_spec.rb +40 -0
  135. data/spec/models/inline_response401_spec.rb +54 -0
  136. data/spec/models/inline_response409_spec.rb +50 -0
  137. data/spec/models/introspect_response_spec.rb +52 -0
  138. data/spec/models/location_no_non_null_request_spec.rb +58 -0
  139. data/spec/models/location_response_spec.rb +58 -0
  140. data/spec/models/message_response_spec.rb +34 -0
  141. data/spec/models/mode_request_spec.rb +28 -0
  142. data/spec/models/mode_response_spec.rb +28 -0
  143. data/spec/models/payrun_response_spec.rb +78 -0
  144. data/spec/models/payslip_response_contributions_spec.rb +40 -0
  145. data/spec/models/payslip_response_deductions_spec.rb +40 -0
  146. data/spec/models/payslip_response_earnings_spec.rb +46 -0
  147. data/spec/models/payslip_response_spec.rb +116 -0
  148. data/spec/models/payslip_response_taxes_spec.rb +46 -0
  149. data/spec/models/provider_request_spec.rb +28 -0
  150. data/spec/models/provider_response_spec.rb +28 -0
  151. data/spec/models/scopes_request_spec.rb +28 -0
  152. data/spec/models/scopes_response_spec.rb +28 -0
  153. data/spec/models/time_off_balance_response_spec.rb +80 -0
  154. data/spec/models/time_off_entry_response_spec.rb +108 -0
  155. data/spec/models/timesheet_response_spec.rb +76 -0
  156. data/spec/models/token_request_spec.rb +62 -0
  157. data/spec/models/token_response_spec.rb +62 -0
  158. data/spec/spec_helper.rb +111 -0
  159. metadata +349 -0
@@ -0,0 +1,24 @@
1
+ # OpenapiClient::ClientRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **client_secret** | **Array<String>** | The client secret(s). It is an array datatype to allow for rotation of secrets without downtime for your customers | |
8
+ | **redirect_uris** | **Array<String>** | Indicates the URI to return the user to after authorization is complete, which is the endpoint on your server to receive the authorization_code. Must be identical to the redirect URI provided in the original link. Please email me after signup and I will set both your client secret and redirect_uri (required) when you reach out. | |
9
+ | **name** | **String** | Name of your app that shows up in the Affix Connect application | |
10
+ | **webhook_uri** | **String** | If enabled, webhooks will be sent to this endpoint | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'openapi_client'
16
+
17
+ instance = OpenapiClient::ClientRequest.new(
18
+ client_secret: ["ffffffff-ffffffff-ffffffff-ffffffff","aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"],
19
+ redirect_uris: ["https://app.your-company.com","https://dev.app.your-company.com"],
20
+ name: Your App,
21
+ webhook_uri: https://webhooks.your-company.com/aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # OpenapiClient::ClientResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **client_id** | **String** | The client ID you received when you first created the application | [readonly] |
8
+ | **client_secret** | **Array<String>** | The client secret(s). It is an array datatype to allow for rotation of secrets without downtime for your customers | |
9
+ | **redirect_uris** | **Array<String>** | Indicates the URI to return the user to after authorization is complete, which is the endpoint on your server to receive the authorization_code. Must be identical to the redirect URI provided in the original link. Please email me after signup and I will set both your client secret and redirect_uri (required) when you reach out. | |
10
+ | **name** | **String** | Name of your app that shows up in the Affix Connect application | |
11
+ | **webhook_uri** | **String** | If enabled, webhooks will be sent to this endpoint | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'openapi_client'
17
+
18
+ instance = OpenapiClient::ClientResponse.new(
19
+ client_id: 00000000-00000000-00000000-00000000,
20
+ client_secret: ["ffffffff-ffffffff-ffffffff-ffffffff","aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa"],
21
+ redirect_uris: ["https://app.your-company.com","https://dev.app.your-company.com"],
22
+ name: Your App,
23
+ webhook_uri: https://webhooks.your-company.com/aaaaaaaa-aaaaaaaa-aaaaaaaa-aaaaaaaa
24
+ )
25
+ ```
26
+
@@ -0,0 +1,28 @@
1
+ # OpenapiClient::CompanyResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The Affix-assigned id of the abscence | |
8
+ | **remote_id** | **String** | the remote system-assigned id of the abscence | |
9
+ | **legal_name** | **String** | | |
10
+ | **display_name** | **String** | | |
11
+ | **tax_id** | **String** | | |
12
+ | **address** | [**AddressResponse**](AddressResponse.md) | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'openapi_client'
18
+
19
+ instance = OpenapiClient::CompanyResponse.new(
20
+ id: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
21
+ remote_id: 19202938,
22
+ legal_name: Affix,
23
+ display_name: Affix API Limited,
24
+ tax_id: 12-3456789,
25
+ address: null
26
+ )
27
+ ```
28
+
data/docs/CoreApi.md ADDED
@@ -0,0 +1,69 @@
1
+ # OpenapiClient::CoreApi
2
+
3
+ All URIs are relative to *https://api.affixapi.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**providers**](CoreApi.md#providers) | **GET** /providers | Providers |
8
+
9
+
10
+ ## providers
11
+
12
+ > Array<Object> providers
13
+
14
+ Providers
15
+
16
+ Retrieve the api modes (official, developer) and providers for the respective modes
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'openapi_client'
23
+
24
+ api_instance = OpenapiClient::CoreApi.new
25
+
26
+ begin
27
+ # Providers
28
+ result = api_instance.providers
29
+ p result
30
+ rescue OpenapiClient::ApiError => e
31
+ puts "Error when calling CoreApi->providers: #{e}"
32
+ end
33
+ ```
34
+
35
+ #### Using the providers_with_http_info variant
36
+
37
+ This returns an Array which contains the response data, status code and headers.
38
+
39
+ > <Array(Array&lt;Object&gt;, Integer, Hash)> providers_with_http_info
40
+
41
+ ```ruby
42
+ begin
43
+ # Providers
44
+ data, status_code, headers = api_instance.providers_with_http_info
45
+ p status_code # => 2xx
46
+ p headers # => { ... }
47
+ p data # => Array&lt;Object&gt;
48
+ rescue OpenapiClient::ApiError => e
49
+ puts "Error when calling CoreApi->providers_with_http_info: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+ This endpoint does not need any parameter.
56
+
57
+ ### Return type
58
+
59
+ **Array&lt;Object&gt;**
60
+
61
+ ### Authorization
62
+
63
+ No authorization required
64
+
65
+ ### HTTP request headers
66
+
67
+ - **Content-Type**: Not defined
68
+ - **Accept**: application/json
69
+
@@ -0,0 +1,68 @@
1
+ # OpenapiClient::CreateEmployeeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **employee_number** | **String** | | [optional] |
8
+ | **first_name** | **String** | the first name of the individual | |
9
+ | **last_name** | **String** | the last name of the individual | |
10
+ | **display_full_name** | **String** | | [optional] |
11
+ | **nationality** | **String** | | [optional] |
12
+ | **job_title** | **String** | | [optional] |
13
+ | **work_email** | **String** | the work email of the individual | [optional] |
14
+ | **personal_email** | **String** | the personal email of the individual | [optional] |
15
+ | **mobile_phone_number** | **String** | +1234567890 | [optional] |
16
+ | **tax_id** | **String** | | [optional] |
17
+ | **gender** | **String** | | [optional] |
18
+ | **ethnicity** | **String** | | [optional] |
19
+ | **marital_status** | **String** | | [optional] |
20
+ | **date_of_birth** | **Date** | | [optional] |
21
+ | **employment_status** | **String** | | [optional] |
22
+ | **employment_type** | **String** | | [optional] |
23
+ | **start_date** | **Date** | | [optional] |
24
+ | **termination_date** | **Date** | | [optional] |
25
+ | **avatar** | **String** | | [optional] |
26
+ | **home_location** | [**AddressNoNonNullRequest**](AddressNoNonNullRequest.md) | | [optional] |
27
+ | **work_location** | [**LocationNoNonNullRequest**](LocationNoNonNullRequest.md) | | [optional] |
28
+ | **manager** | [**CreateEmployeeRequestManager**](CreateEmployeeRequestManager.md) | | [optional] |
29
+ | **bank_account** | [**CreateEmployeeRequestBankAccount**](CreateEmployeeRequestBankAccount.md) | | [optional] |
30
+ | **employments** | [**Array&lt;EmploymentNoNullEnumRequest&gt;**](EmploymentNoNullEnumRequest.md) | | [optional] |
31
+ | **custom_fields** | **Object** | | [optional] |
32
+ | **groups** | [**Array&lt;GroupNoNullEnumRequest&gt;**](GroupNoNullEnumRequest.md) | | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'openapi_client'
38
+
39
+ instance = OpenapiClient::CreateEmployeeRequest.new(
40
+ employee_number: 2,
41
+ first_name: Greg,
42
+ last_name: Hirsch,
43
+ display_full_name: Hirsch,
44
+ nationality: Irish,
45
+ job_title: Software developer,
46
+ work_email: greg@affixapi.com,
47
+ personal_email: greg@gmail.com,
48
+ mobile_phone_number: Hirsch,
49
+ tax_id: 1234567890,
50
+ gender: male,
51
+ ethnicity: white,
52
+ marital_status: single,
53
+ date_of_birth: Sat Nov 10 00:00:00 UTC 1990,
54
+ employment_status: active,
55
+ employment_type: full_time,
56
+ start_date: Sun Oct 11 00:00:00 UTC 2020,
57
+ termination_date: Tue Oct 12 00:00:00 UTC 2021,
58
+ avatar: http://alturl.com/h2h8m,
59
+ home_location: null,
60
+ work_location: null,
61
+ manager: null,
62
+ bank_account: null,
63
+ employments: null,
64
+ custom_fields: {&quot;t_shirt_size&quot;:&quot;medium&quot;},
65
+ groups: [{&quot;id&quot;:&quot;4B9bKBpX5tnwjiG93TAqF7ci&quot;,&quot;remote_id&quot;:&quot;df6c28e8&quot;,&quot;name&quot;:&quot;backend&quot;,&quot;type&quot;:&quot;team&quot;},{&quot;id&quot;:&quot;132Xpnw2a38aaQG93TAqF7ci&quot;,&quot;remote_id&quot;:&quot;355c65922637&quot;,&quot;name&quot;:&quot;engineering&quot;,&quot;type&quot;:&quot;department&quot;}]
66
+ )
67
+ ```
68
+
@@ -0,0 +1,26 @@
1
+ # OpenapiClient::CreateEmployeeRequestBankAccount
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_number** | **String** | | |
8
+ | **bank_name** | **String** | | |
9
+ | **bic** | **String** | | |
10
+ | **holder_name** | **String** | | |
11
+ | **iban** | **String** | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'openapi_client'
17
+
18
+ instance = OpenapiClient::CreateEmployeeRequestBankAccount.new(
19
+ account_number: null,
20
+ bank_name: null,
21
+ bic: null,
22
+ holder_name: null,
23
+ iban: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # OpenapiClient::CreateEmployeeRequestManager
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | | |
8
+ | **last_name** | **String** | | |
9
+ | **id** | **String** | | |
10
+ | **work_email** | **String** | | |
11
+ | **remote_id** | **String** | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'openapi_client'
17
+
18
+ instance = OpenapiClient::CreateEmployeeRequestManager.new(
19
+ first_name: null,
20
+ last_name: null,
21
+ id: null,
22
+ work_email: null,
23
+ remote_id: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,15 @@
1
+ # OpenapiClient::CurrencyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'openapi_client'
12
+
13
+ instance = OpenapiClient::CurrencyRequest.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # OpenapiClient::CurrencyResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'openapi_client'
12
+
13
+ instance = OpenapiClient::CurrencyResponse.new()
14
+ ```
15
+