affixapi 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +19 -0
- data/README.md +374 -0
- data/Rakefile +10 -0
- data/affixapi.gemspec +38 -0
- data/docs/AddressNoNonNullRequest.md +26 -0
- data/docs/AddressResponse.md +26 -0
- data/docs/Class20230301Api.md +1401 -0
- data/docs/ClientRequest.md +24 -0
- data/docs/ClientResponse.md +26 -0
- data/docs/CompanyResponse.md +28 -0
- data/docs/CoreApi.md +69 -0
- data/docs/CreateEmployeeRequest.md +68 -0
- data/docs/CreateEmployeeRequestBankAccount.md +26 -0
- data/docs/CreateEmployeeRequestManager.md +26 -0
- data/docs/CurrencyRequest.md +15 -0
- data/docs/CurrencyResponse.md +15 -0
- data/docs/DeveloperApi.md +777 -0
- data/docs/DisconnectResponse.md +18 -0
- data/docs/EmployeeResponse.md +74 -0
- data/docs/EmploymentNoNullEnumRequest.md +30 -0
- data/docs/EmploymentResponse.md +30 -0
- data/docs/GroupNoNullEnumRequest.md +24 -0
- data/docs/GroupResponse.md +24 -0
- data/docs/IdAndMessageResponse.md +20 -0
- data/docs/IdentityResponse.md +22 -0
- data/docs/InlineResponse400.md +20 -0
- data/docs/InlineResponse401.md +22 -0
- data/docs/InlineResponse409.md +22 -0
- data/docs/IntrospectResponse.md +24 -0
- data/docs/LocationNoNonNullRequest.md +26 -0
- data/docs/LocationResponse.md +26 -0
- data/docs/ManagementApi.md +420 -0
- data/docs/MessageResponse.md +18 -0
- data/docs/ModeRequest.md +15 -0
- data/docs/ModeResponse.md +15 -0
- data/docs/OfficialApi.md +631 -0
- data/docs/PayrunResponse.md +30 -0
- data/docs/PayslipResponse.md +44 -0
- data/docs/PayslipResponseContributions.md +20 -0
- data/docs/PayslipResponseDeductions.md +20 -0
- data/docs/PayslipResponseEarnings.md +22 -0
- data/docs/PayslipResponseTaxes.md +22 -0
- data/docs/ProviderRequest.md +15 -0
- data/docs/ProviderResponse.md +15 -0
- data/docs/ScopesRequest.md +15 -0
- data/docs/ScopesResponse.md +15 -0
- data/docs/TimeOffBalanceResponse.md +32 -0
- data/docs/TimeOffEntryResponse.md +40 -0
- data/docs/TimesheetResponse.md +32 -0
- data/docs/TokenRequest.md +26 -0
- data/docs/TokenResponse.md +26 -0
- data/git_push.sh +58 -0
- data/lib/openapi_client/api/class20230301_api.rb +1198 -0
- data/lib/openapi_client/api/core_api.rb +79 -0
- data/lib/openapi_client/api/developer_api.rb +677 -0
- data/lib/openapi_client/api/management_api.rb +380 -0
- data/lib/openapi_client/api/official_api.rb +543 -0
- data/lib/openapi_client/api_client.rb +390 -0
- data/lib/openapi_client/api_error.rb +57 -0
- data/lib/openapi_client/configuration.rb +288 -0
- data/lib/openapi_client/models/address_no_non_null_request.rb +295 -0
- data/lib/openapi_client/models/address_response.rb +295 -0
- data/lib/openapi_client/models/client_request.rb +269 -0
- data/lib/openapi_client/models/client_response.rb +284 -0
- data/lib/openapi_client/models/company_response.rb +279 -0
- data/lib/openapi_client/models/create_employee_request.rb +568 -0
- data/lib/openapi_client/models/create_employee_request_bank_account.rb +259 -0
- data/lib/openapi_client/models/create_employee_request_manager.rb +263 -0
- data/lib/openapi_client/models/currency_request.rb +38 -0
- data/lib/openapi_client/models/currency_response.rb +38 -0
- data/lib/openapi_client/models/disconnect_response.rb +258 -0
- data/lib/openapi_client/models/employee_response.rb +608 -0
- data/lib/openapi_client/models/employment_no_null_enum_request.rb +329 -0
- data/lib/openapi_client/models/employment_response.rb +329 -0
- data/lib/openapi_client/models/group_no_null_enum_request.rb +283 -0
- data/lib/openapi_client/models/group_response.rb +283 -0
- data/lib/openapi_client/models/id_and_message_response.rb +239 -0
- data/lib/openapi_client/models/identity_response.rb +250 -0
- data/lib/openapi_client/models/inline_response400.rb +227 -0
- data/lib/openapi_client/models/inline_response401.rb +299 -0
- data/lib/openapi_client/models/inline_response409.rb +278 -0
- data/lib/openapi_client/models/introspect_response.rb +269 -0
- data/lib/openapi_client/models/location_no_non_null_request.rb +263 -0
- data/lib/openapi_client/models/location_response.rb +263 -0
- data/lib/openapi_client/models/message_response.rb +223 -0
- data/lib/openapi_client/models/mode_request.rb +37 -0
- data/lib/openapi_client/models/mode_response.rb +37 -0
- data/lib/openapi_client/models/payrun_response.rb +342 -0
- data/lib/openapi_client/models/payslip_response.rb +448 -0
- data/lib/openapi_client/models/payslip_response_contributions.rb +238 -0
- data/lib/openapi_client/models/payslip_response_deductions.rb +238 -0
- data/lib/openapi_client/models/payslip_response_earnings.rb +250 -0
- data/lib/openapi_client/models/payslip_response_taxes.rb +248 -0
- data/lib/openapi_client/models/provider_request.rb +70 -0
- data/lib/openapi_client/models/provider_response.rb +70 -0
- data/lib/openapi_client/models/scopes_request.rb +55 -0
- data/lib/openapi_client/models/scopes_response.rb +55 -0
- data/lib/openapi_client/models/time_off_balance_response.rb +342 -0
- data/lib/openapi_client/models/time_off_entry_response.rb +408 -0
- data/lib/openapi_client/models/timesheet_response.rb +318 -0
- data/lib/openapi_client/models/token_request.rb +318 -0
- data/lib/openapi_client/models/token_response.rb +318 -0
- data/lib/openapi_client/version.rb +15 -0
- data/lib/openapi_client.rb +86 -0
- data/openapi_client-0.0.1.gem +0 -0
- data/pkg/affixapi-0.0.1.gem +0 -0
- data/spec/api/class20230301_api_spec.rb +260 -0
- data/spec/api/core_api_spec.rb +46 -0
- data/spec/api/developer_api_spec.rb +160 -0
- data/spec/api/management_api_spec.rb +103 -0
- data/spec/api/official_api_spec.rb +135 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/address_no_non_null_request_spec.rb +62 -0
- data/spec/models/address_response_spec.rb +62 -0
- data/spec/models/client_request_spec.rb +52 -0
- data/spec/models/client_response_spec.rb +58 -0
- data/spec/models/company_response_spec.rb +64 -0
- data/spec/models/create_employee_request_bank_account_spec.rb +58 -0
- data/spec/models/create_employee_request_manager_spec.rb +58 -0
- data/spec/models/create_employee_request_spec.rb +204 -0
- data/spec/models/currency_request_spec.rb +28 -0
- data/spec/models/currency_response_spec.rb +28 -0
- data/spec/models/disconnect_response_spec.rb +38 -0
- data/spec/models/employee_response_spec.rb +222 -0
- data/spec/models/employment_no_null_enum_request_spec.rb +78 -0
- data/spec/models/employment_response_spec.rb +78 -0
- data/spec/models/group_no_null_enum_request_spec.rb +56 -0
- data/spec/models/group_response_spec.rb +56 -0
- data/spec/models/id_and_message_response_spec.rb +40 -0
- data/spec/models/identity_response_spec.rb +46 -0
- data/spec/models/inline_response400_spec.rb +40 -0
- data/spec/models/inline_response401_spec.rb +54 -0
- data/spec/models/inline_response409_spec.rb +50 -0
- data/spec/models/introspect_response_spec.rb +52 -0
- data/spec/models/location_no_non_null_request_spec.rb +58 -0
- data/spec/models/location_response_spec.rb +58 -0
- data/spec/models/message_response_spec.rb +34 -0
- data/spec/models/mode_request_spec.rb +28 -0
- data/spec/models/mode_response_spec.rb +28 -0
- data/spec/models/payrun_response_spec.rb +78 -0
- data/spec/models/payslip_response_contributions_spec.rb +40 -0
- data/spec/models/payslip_response_deductions_spec.rb +40 -0
- data/spec/models/payslip_response_earnings_spec.rb +46 -0
- data/spec/models/payslip_response_spec.rb +116 -0
- data/spec/models/payslip_response_taxes_spec.rb +46 -0
- data/spec/models/provider_request_spec.rb +28 -0
- data/spec/models/provider_response_spec.rb +28 -0
- data/spec/models/scopes_request_spec.rb +28 -0
- data/spec/models/scopes_response_spec.rb +28 -0
- data/spec/models/time_off_balance_response_spec.rb +80 -0
- data/spec/models/time_off_entry_response_spec.rb +108 -0
- data/spec/models/timesheet_response_spec.rb +76 -0
- data/spec/models/token_request_spec.rb +62 -0
- data/spec/models/token_response_spec.rb +62 -0
- data/spec/spec_helper.rb +111 -0
- metadata +349 -0
@@ -0,0 +1,380 @@
|
|
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 (developer mode) ### dev ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6ImQ1OTZhMmYzLWYzNzktNGE1ZC1hMmRhLTk4OWJmYWViYTg1ZCIsImlhdCI6MTcwMjkyMDkwMywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5kZXYuZW5naW5lZXJpbmcuYWZmaXhhcGkuY29tIiwic3ViIjoiZGV2ZWxvcGVyIiwiYXVkIjoiM0ZEQUVERjktMURDQTRGNTQtODc5NDlGNkEtNDEwMjc2NDMifQ.VLWYjCQvBS0C3ZA6_J3-U-idZj5EYI2IlDdTjAWBxSIHGufp6cqaVodKsF2BeIqcIeB3P0lW-KL9mY3xGd7ckQ ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6ImQ1OTZhMmYzLWYzNzktNGE1ZC1hMmRhLTk4OWJmYWViYTg1ZCIsImlhdCI6MTcwMjkyMDkwMywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5kZXYuZW5naW5lZXJpbmcuYWZmaXhhcGkuY29tIiwic3ViIjoiZGV2ZWxvcGVyIiwiYXVkIjoiM0ZEQUVERjktMURDQTRGNTQtODc5NDlGNkEtNDEwMjc2NDMifQ.VLWYjCQvBS0C3ZA6_J3-U-idZj5EYI2IlDdTjAWBxSIHGufp6cqaVodKsF2BeIqcIeB3P0lW-KL9mY3xGd7ckQ' \\ 'https://dev.api.affixapi.com/2023-03-01/developer/employees' ``` ### prod ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6IjI5YjFjYTg4LWNlNjktNDgyZC1iNGZjLTkzMWMzZmJkYWM4ZSIsImlhdCI6MTcwMjkyMTA4MywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5wcm9kLmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6ImRldmVsb3BlciIsImF1ZCI6IjA4QkIwODFFLUQ5QUI0RDE0LThERjk5MjMzLTY2NjE1Q0U5In0.2zdpFAmiyYiYk6MOcbXNUwwR4M1Fextnaac340x54AidiWXCyw-u9KeavbqfYF6q8a9kcDLrxhJ8Wc_3tIzuVw ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL2lkZW50aXR5IiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3BheXJ1bnMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvcGF5cnVucy86cGF5cnVuX2lkIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWJhbGFuY2VzIiwiLzIwMjMtMDMtMDEvZGV2ZWxvcGVyL3RpbWUtb2ZmLWVudHJpZXMiLCIvMjAyMy0wMy0wMS9kZXZlbG9wZXIvdGltZXNoZWV0cyJdLCJ0b2tlbiI6IjI5YjFjYTg4LWNlNjktNDgyZC1iNGZjLTkzMWMzZmJkYWM4ZSIsImlhdCI6MTcwMjkyMTA4MywiaXNzIjoicHVibGljYXBpLWludGVybWVkaWF0ZS5wcm9kLmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6ImRldmVsb3BlciIsImF1ZCI6IjA4QkIwODFFLUQ5QUI0RDE0LThERjk5MjMzLTY2NjE1Q0U5In0.2zdpFAmiyYiYk6MOcbXNUwwR4M1Fextnaac340x54AidiWXCyw-u9KeavbqfYF6q8a9kcDLrxhJ8Wc_3tIzuVw' \\ 'https://api.affixapi.com/2023-03-01/developer/employees' ``` # 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; }; ``` ## 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 'cgi'
|
14
|
+
|
15
|
+
module OpenapiClient
|
16
|
+
class ManagementApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Client
|
23
|
+
# View client attributes
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [ClientResponse]
|
26
|
+
def client(opts = {})
|
27
|
+
data, _status_code, _headers = client_with_http_info(opts)
|
28
|
+
data
|
29
|
+
end
|
30
|
+
|
31
|
+
# Client
|
32
|
+
# View client attributes
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(ClientResponse, Integer, Hash)>] ClientResponse data, response status code and response headers
|
35
|
+
def client_with_http_info(opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.client ...'
|
38
|
+
end
|
39
|
+
# resource path
|
40
|
+
local_var_path = '/2023-03-01/management/client'
|
41
|
+
|
42
|
+
# query parameters
|
43
|
+
query_params = opts[:query_params] || {}
|
44
|
+
|
45
|
+
# header parameters
|
46
|
+
header_params = opts[:header_params] || {}
|
47
|
+
# HTTP header 'Accept' (if needed)
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
49
|
+
|
50
|
+
# form parameters
|
51
|
+
form_params = opts[:form_params] || {}
|
52
|
+
|
53
|
+
# http body (model)
|
54
|
+
post_body = opts[:debug_body]
|
55
|
+
|
56
|
+
# return_type
|
57
|
+
return_type = opts[:debug_return_type] || 'ClientResponse'
|
58
|
+
|
59
|
+
# auth_names
|
60
|
+
auth_names = opts[:debug_auth_names] || ['basic']
|
61
|
+
|
62
|
+
new_options = opts.merge(
|
63
|
+
:operation => :"ManagementApi.client",
|
64
|
+
:header_params => header_params,
|
65
|
+
:query_params => query_params,
|
66
|
+
:form_params => form_params,
|
67
|
+
:body => post_body,
|
68
|
+
:auth_names => auth_names,
|
69
|
+
:return_type => return_type
|
70
|
+
)
|
71
|
+
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
73
|
+
if @api_client.config.debugging
|
74
|
+
@api_client.config.logger.debug "API called: ManagementApi#client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
|
+
end
|
76
|
+
return data, status_code, headers
|
77
|
+
end
|
78
|
+
|
79
|
+
# Disconnect token
|
80
|
+
# Disconnect the token. A disconnected token will no longer return data. Data requests with a disconnected token will return a 403 Forbidden
|
81
|
+
# @param [Hash] opts the optional parameters
|
82
|
+
# @return [DisconnectResponse]
|
83
|
+
def disconnect(opts = {})
|
84
|
+
data, _status_code, _headers = disconnect_with_http_info(opts)
|
85
|
+
data
|
86
|
+
end
|
87
|
+
|
88
|
+
# Disconnect token
|
89
|
+
# Disconnect the token. A disconnected token will no longer return data. Data requests with a disconnected token will return a 403 Forbidden
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [Array<(DisconnectResponse, Integer, Hash)>] DisconnectResponse data, response status code and response headers
|
92
|
+
def disconnect_with_http_info(opts = {})
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.disconnect ...'
|
95
|
+
end
|
96
|
+
# resource path
|
97
|
+
local_var_path = '/2023-03-01/management/disconnect'
|
98
|
+
|
99
|
+
# query parameters
|
100
|
+
query_params = opts[:query_params] || {}
|
101
|
+
|
102
|
+
# header parameters
|
103
|
+
header_params = opts[:header_params] || {}
|
104
|
+
# HTTP header 'Accept' (if needed)
|
105
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
106
|
+
|
107
|
+
# form parameters
|
108
|
+
form_params = opts[:form_params] || {}
|
109
|
+
|
110
|
+
# http body (model)
|
111
|
+
post_body = opts[:debug_body]
|
112
|
+
|
113
|
+
# return_type
|
114
|
+
return_type = opts[:debug_return_type] || 'DisconnectResponse'
|
115
|
+
|
116
|
+
# auth_names
|
117
|
+
auth_names = opts[:debug_auth_names] || ['access-token']
|
118
|
+
|
119
|
+
new_options = opts.merge(
|
120
|
+
:operation => :"ManagementApi.disconnect",
|
121
|
+
:header_params => header_params,
|
122
|
+
:query_params => query_params,
|
123
|
+
:form_params => form_params,
|
124
|
+
:body => post_body,
|
125
|
+
:auth_names => auth_names,
|
126
|
+
:return_type => return_type
|
127
|
+
)
|
128
|
+
|
129
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
130
|
+
if @api_client.config.debugging
|
131
|
+
@api_client.config.logger.debug "API called: ManagementApi#disconnect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
132
|
+
end
|
133
|
+
return data, status_code, headers
|
134
|
+
end
|
135
|
+
|
136
|
+
# Inspect token
|
137
|
+
# Retrieve data about the token, such as `scopes`, `mode`, `provider`, and if it is active
|
138
|
+
# @param [Hash] opts the optional parameters
|
139
|
+
# @return [IntrospectResponse]
|
140
|
+
def introspect(opts = {})
|
141
|
+
data, _status_code, _headers = introspect_with_http_info(opts)
|
142
|
+
data
|
143
|
+
end
|
144
|
+
|
145
|
+
# Inspect token
|
146
|
+
# Retrieve data about the token, such as `scopes`, `mode`, `provider`, and if it is active
|
147
|
+
# @param [Hash] opts the optional parameters
|
148
|
+
# @return [Array<(IntrospectResponse, Integer, Hash)>] IntrospectResponse data, response status code and response headers
|
149
|
+
def introspect_with_http_info(opts = {})
|
150
|
+
if @api_client.config.debugging
|
151
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.introspect ...'
|
152
|
+
end
|
153
|
+
# resource path
|
154
|
+
local_var_path = '/2023-03-01/management/introspect'
|
155
|
+
|
156
|
+
# query parameters
|
157
|
+
query_params = opts[:query_params] || {}
|
158
|
+
|
159
|
+
# header parameters
|
160
|
+
header_params = opts[:header_params] || {}
|
161
|
+
# HTTP header 'Accept' (if needed)
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
163
|
+
|
164
|
+
# form parameters
|
165
|
+
form_params = opts[:form_params] || {}
|
166
|
+
|
167
|
+
# http body (model)
|
168
|
+
post_body = opts[:debug_body]
|
169
|
+
|
170
|
+
# return_type
|
171
|
+
return_type = opts[:debug_return_type] || 'IntrospectResponse'
|
172
|
+
|
173
|
+
# auth_names
|
174
|
+
auth_names = opts[:debug_auth_names] || ['access-token']
|
175
|
+
|
176
|
+
new_options = opts.merge(
|
177
|
+
:operation => :"ManagementApi.introspect",
|
178
|
+
:header_params => header_params,
|
179
|
+
:query_params => query_params,
|
180
|
+
:form_params => form_params,
|
181
|
+
:body => post_body,
|
182
|
+
:auth_names => auth_names,
|
183
|
+
:return_type => return_type
|
184
|
+
)
|
185
|
+
|
186
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
187
|
+
if @api_client.config.debugging
|
188
|
+
@api_client.config.logger.debug "API called: ManagementApi#introspect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
189
|
+
end
|
190
|
+
return data, status_code, headers
|
191
|
+
end
|
192
|
+
|
193
|
+
# Create token
|
194
|
+
# Exchange an `authorization_code` for an `access_token` after receiving on from the `redirect_uri` you specifiy after a successful user connection
|
195
|
+
# @param token_request [TokenRequest]
|
196
|
+
# @param [Hash] opts the optional parameters
|
197
|
+
# @return [TokenResponse]
|
198
|
+
def token(token_request, opts = {})
|
199
|
+
data, _status_code, _headers = token_with_http_info(token_request, opts)
|
200
|
+
data
|
201
|
+
end
|
202
|
+
|
203
|
+
# Create token
|
204
|
+
# Exchange an `authorization_code` for an `access_token` after receiving on from the `redirect_uri` you specifiy after a successful user connection
|
205
|
+
# @param token_request [TokenRequest]
|
206
|
+
# @param [Hash] opts the optional parameters
|
207
|
+
# @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers
|
208
|
+
def token_with_http_info(token_request, opts = {})
|
209
|
+
if @api_client.config.debugging
|
210
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.token ...'
|
211
|
+
end
|
212
|
+
# verify the required parameter 'token_request' is set
|
213
|
+
if @api_client.config.client_side_validation && token_request.nil?
|
214
|
+
fail ArgumentError, "Missing the required parameter 'token_request' when calling ManagementApi.token"
|
215
|
+
end
|
216
|
+
# resource path
|
217
|
+
local_var_path = '/2023-03-01/management/token'
|
218
|
+
|
219
|
+
# query parameters
|
220
|
+
query_params = opts[:query_params] || {}
|
221
|
+
|
222
|
+
# header parameters
|
223
|
+
header_params = opts[:header_params] || {}
|
224
|
+
# HTTP header 'Accept' (if needed)
|
225
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
226
|
+
# HTTP header 'Content-Type'
|
227
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
228
|
+
|
229
|
+
# form parameters
|
230
|
+
form_params = opts[:form_params] || {}
|
231
|
+
|
232
|
+
# http body (model)
|
233
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(token_request)
|
234
|
+
|
235
|
+
# return_type
|
236
|
+
return_type = opts[:debug_return_type] || 'TokenResponse'
|
237
|
+
|
238
|
+
# auth_names
|
239
|
+
auth_names = opts[:debug_auth_names] || []
|
240
|
+
|
241
|
+
new_options = opts.merge(
|
242
|
+
:operation => :"ManagementApi.token",
|
243
|
+
:header_params => header_params,
|
244
|
+
:query_params => query_params,
|
245
|
+
:form_params => form_params,
|
246
|
+
:body => post_body,
|
247
|
+
:auth_names => auth_names,
|
248
|
+
:return_type => return_type
|
249
|
+
)
|
250
|
+
|
251
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
252
|
+
if @api_client.config.debugging
|
253
|
+
@api_client.config.logger.debug "API called: ManagementApi#token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
254
|
+
end
|
255
|
+
return data, status_code, headers
|
256
|
+
end
|
257
|
+
|
258
|
+
# Tokens
|
259
|
+
# View tokens and token status for respective client
|
260
|
+
# @param [Hash] opts the optional parameters
|
261
|
+
# @return [Array<Object>]
|
262
|
+
def tokens(opts = {})
|
263
|
+
data, _status_code, _headers = tokens_with_http_info(opts)
|
264
|
+
data
|
265
|
+
end
|
266
|
+
|
267
|
+
# Tokens
|
268
|
+
# View tokens and token status for respective client
|
269
|
+
# @param [Hash] opts the optional parameters
|
270
|
+
# @return [Array<(Array<Object>, Integer, Hash)>] Array<Object> data, response status code and response headers
|
271
|
+
def tokens_with_http_info(opts = {})
|
272
|
+
if @api_client.config.debugging
|
273
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.tokens ...'
|
274
|
+
end
|
275
|
+
# resource path
|
276
|
+
local_var_path = '/2023-03-01/management/tokens'
|
277
|
+
|
278
|
+
# query parameters
|
279
|
+
query_params = opts[:query_params] || {}
|
280
|
+
|
281
|
+
# header parameters
|
282
|
+
header_params = opts[:header_params] || {}
|
283
|
+
# HTTP header 'Accept' (if needed)
|
284
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
285
|
+
|
286
|
+
# form parameters
|
287
|
+
form_params = opts[:form_params] || {}
|
288
|
+
|
289
|
+
# http body (model)
|
290
|
+
post_body = opts[:debug_body]
|
291
|
+
|
292
|
+
# return_type
|
293
|
+
return_type = opts[:debug_return_type] || 'Array<Object>'
|
294
|
+
|
295
|
+
# auth_names
|
296
|
+
auth_names = opts[:debug_auth_names] || ['basic']
|
297
|
+
|
298
|
+
new_options = opts.merge(
|
299
|
+
:operation => :"ManagementApi.tokens",
|
300
|
+
:header_params => header_params,
|
301
|
+
:query_params => query_params,
|
302
|
+
:form_params => form_params,
|
303
|
+
:body => post_body,
|
304
|
+
:auth_names => auth_names,
|
305
|
+
:return_type => return_type
|
306
|
+
)
|
307
|
+
|
308
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
309
|
+
if @api_client.config.debugging
|
310
|
+
@api_client.config.logger.debug "API called: ManagementApi#tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
311
|
+
end
|
312
|
+
return data, status_code, headers
|
313
|
+
end
|
314
|
+
|
315
|
+
# Update client
|
316
|
+
# Update attributes of the client. Update the `name`, `client_secret`, or `webhook_uri` of the client
|
317
|
+
# @param client_request [ClientRequest]
|
318
|
+
# @param [Hash] opts the optional parameters
|
319
|
+
# @return [ClientResponse]
|
320
|
+
def update_client(client_request, opts = {})
|
321
|
+
data, _status_code, _headers = update_client_with_http_info(client_request, opts)
|
322
|
+
data
|
323
|
+
end
|
324
|
+
|
325
|
+
# Update client
|
326
|
+
# Update attributes of the client. Update the `name`, `client_secret`, or `webhook_uri` of the client
|
327
|
+
# @param client_request [ClientRequest]
|
328
|
+
# @param [Hash] opts the optional parameters
|
329
|
+
# @return [Array<(ClientResponse, Integer, Hash)>] ClientResponse data, response status code and response headers
|
330
|
+
def update_client_with_http_info(client_request, opts = {})
|
331
|
+
if @api_client.config.debugging
|
332
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.update_client ...'
|
333
|
+
end
|
334
|
+
# verify the required parameter 'client_request' is set
|
335
|
+
if @api_client.config.client_side_validation && client_request.nil?
|
336
|
+
fail ArgumentError, "Missing the required parameter 'client_request' when calling ManagementApi.update_client"
|
337
|
+
end
|
338
|
+
# resource path
|
339
|
+
local_var_path = '/2023-03-01/management/client'
|
340
|
+
|
341
|
+
# query parameters
|
342
|
+
query_params = opts[:query_params] || {}
|
343
|
+
|
344
|
+
# header parameters
|
345
|
+
header_params = opts[:header_params] || {}
|
346
|
+
# HTTP header 'Accept' (if needed)
|
347
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
348
|
+
# HTTP header 'Content-Type'
|
349
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
350
|
+
|
351
|
+
# form parameters
|
352
|
+
form_params = opts[:form_params] || {}
|
353
|
+
|
354
|
+
# http body (model)
|
355
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(client_request)
|
356
|
+
|
357
|
+
# return_type
|
358
|
+
return_type = opts[:debug_return_type] || 'ClientResponse'
|
359
|
+
|
360
|
+
# auth_names
|
361
|
+
auth_names = opts[:debug_auth_names] || ['basic']
|
362
|
+
|
363
|
+
new_options = opts.merge(
|
364
|
+
:operation => :"ManagementApi.update_client",
|
365
|
+
:header_params => header_params,
|
366
|
+
:query_params => query_params,
|
367
|
+
:form_params => form_params,
|
368
|
+
:body => post_body,
|
369
|
+
:auth_names => auth_names,
|
370
|
+
:return_type => return_type
|
371
|
+
)
|
372
|
+
|
373
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
374
|
+
if @api_client.config.debugging
|
375
|
+
@api_client.config.logger.debug "API called: ManagementApi#update_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
376
|
+
end
|
377
|
+
return data, status_code, headers
|
378
|
+
end
|
379
|
+
end
|
380
|
+
end
|