Updated following file(s): accounting.yml, ats.yml, crm.yml, ecommerc…

…e.yml, file-storage.yml, hris.yml, lead.yml, pos.yml, sms.yml, issue-tracking.yml, connector.yml, proxy.yml, vault.yml, webhook.yml, CHANGELOG.md
apideck-libraries · Oct 21, 2024 · 5e72097 · 5e72097
1 parent 236bb1c
commit 5e72097
Show file tree

Hide file tree

Showing 15 changed files with 42 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -194,7 +194,7 @@
 - Added of the [Cezanne HR](connectors/cezannehr) connector as early-access
 - Improved mapping manager for employee for [AFAS](connectors/afas)
 
-- Added and improved of the mapping for departments for integrations: [AFAS](connectors/afas), [AlexisHR](connectors/alexishr), [BambooHR](connectors/bamboohr), [Breathe HR](connectors/breathehr]), [Deel](connectors/deel), [Loket](connectors/loket-nl), [Lucca HR](connectors/lucca-hr), [Rippling](connectors/rippling) , [NMBRS](connectors/nmbrs), [Officient](connectors/officient-io),
+- Added and improved of the mapping for departments for integrations: [AFAS](connectors/afas), [AlexisHR](connectors/alexishr), [BambooHR](connectors/bamboohr), [Breathe HR](connectors/breathehr), [Deel](connectors/deel), [Loket](connectors/loket-nl), [Lucca HR](connectors/lucca-hr), [Rippling](connectors/rippling) , [NMBRS](connectors/nmbrs), [Officient](connectors/officient-io),
 
 ### Issue tracking
 
@@ -276,8 +276,8 @@
 - Improved employee mapping & pagination for [UKG Pro](connectors/ukg-pro)
 - Deprecated API key authentication & "people" endpoint for [Hibob](connectors/hibob) in favor a new faster "people/search" endpoint and Service User authentication.
 - Improved employee mapping for [Hibob](connectors/hibob)
-- Extended the employee mapping for [Ceridian Dayforce](connectors/ceridian-dayforce])
-- Overall improvements of the coverage for employee properties for integrations: [Officient](connectors/officient-io), [Namely](connectors/namely), [Paychex](connectors/paychex), [PayFit](connectors/payfit), [Ceridian Dayforce](connectors/ceridian-dayforce]), [Cegid talentsoft](connectors/cegid-talentsoft), [Employment Hero](connectors/employmenthero)
+- Extended the employee mapping for [Ceridian Dayforce](connectors/ceridian-dayforce)
+- Overall improvements of the coverage for employee properties for integrations: [Officient](connectors/officient-io), [Namely](connectors/namely), [Paychex](connectors/paychex), [PayFit](connectors/payfit), [Ceridian Dayforce](connectors/ceridian-dayforce), [Cegid talentsoft](connectors/cegid-talentsoft), [Employment Hero](connectors/employmenthero)
 - Employee model `leaving_reason` can be null
 
 ### Accounting API
@@ -311,7 +311,7 @@
 
 - Release of the [Charlie HR](connectors/charliehr) connector with support for the resources: Employee, Department, Time-off
 - The [Humaans](connectors/humaans)-io includes inactive employees by default.
-- Overall improvements of the coverage for employee properties for integrations: [Google Workspace](connectors/google-workspace), [Lucca HR](connectors/lucca-hr), [Rippling](connectors/rippling) ,[SD Worx](connectors/sdworx), [ADP run](connectors/adp-run), [ADP Workforce Now](connectors/adp-workforce-now), [Breathe HR](connectors/breathehr]), [Deel](connectors/deel), [Freshteam](connectors/freshteam), [Loket](connectors/loket-nl), [Paylocity](connectors/paylocity), [NMBRS](connectors/nmbrs), [Sage HR](connectors/sage-hr), [Zenefits](connectors/zenefits)
+- Overall improvements of the coverage for employee properties for integrations: [Google Workspace](connectors/google-workspace), [Lucca HR](connectors/lucca-hr), [Rippling](connectors/rippling) ,[SD Worx](connectors/sdworx), [ADP run](connectors/adp-run), [ADP Workforce Now](connectors/adp-workforce-now), [Breathe HR](connectors/breathehr), [Deel](connectors/deel), [Freshteam](connectors/freshteam), [Loket](connectors/loket-nl), [Paylocity](connectors/paylocity), [NMBRS](connectors/nmbrs), [Sage HR](connectors/sage-hr), [Zenefits](connectors/zenefits)
 
 ### Filestorage API
 
@@ -367,7 +367,7 @@
 - Added departments resource mapping for [Humaans](connectors/humaans-io)
 - Added departments resource mapping for [Google Workspace](connectors/google-workspace)
 
-- Mapped the ethnicity field for the connectors that support it: [ADP run](connectors/adp-run), [ADP Workforce Now](connectors/adp-workforce-now), [BambooHR](connectors/bamboohr), [Breathe HR](connectors/breathehr]), [Cascade HR](connectors/cascade-hr]), [Ceridian Dayforce](connectors/ceridian-dayforce]), [Hibob](connectors/hibob), [Justworks](connectors/justworks), [Namely](connectors/namely), [Paychex](connectors/paychex), [Trinet](connectors/trinet), [UKG Pro](connectors/ukg-pro), [Workday](connectors/workday)
+- Mapped the ethnicity field for the connectors that support it: [ADP run](connectors/adp-run), [ADP Workforce Now](connectors/adp-workforce-now), [BambooHR](connectors/bamboohr), [Breathe HR](connectors/breathehr), [Cascade HR](connectors/cascade-hr), [Ceridian Dayforce](connectors/ceridian-dayforce), [Hibob](connectors/hibob), [Justworks](connectors/justworks), [Namely](connectors/namely), [Paychex](connectors/paychex), [Trinet](connectors/trinet), [UKG Pro](connectors/ukg-pro), [Workday](connectors/workday)
 
 ### Accounting API
 
@@ -968,7 +968,7 @@ Added the [Ecommerce API](apis/ecommerce/reference).
 
 ## v8.52.1 - (2022-09-09)
 
-- Generalize example detail for Unprocessable Entity Error to prevent confusing when using the [Mock API](mock-api).
+- Generalize example detail for Unprocessable Entity Error to prevent confusing when using the Mock API (sunsetted).
 
 ## v8.52.0 - (2022-09-07)
 

diff --git a/accounting.yml b/accounting.yml
diff --git a/ats.yml b/ats.yml
diff --git a/connector.yml b/connector.yml
diff --git a/crm.yml b/crm.yml
diff --git a/ecommerce.yml b/ecommerce.yml
diff --git a/file-storage.yml b/file-storage.yml
diff --git a/hris.yml b/hris.yml
diff --git a/issue-tracking.yml b/issue-tracking.yml
diff --git a/lead.yml b/lead.yml
diff --git a/pos.yml b/pos.yml
diff --git a/proxy.yml b/proxy.yml
@@ -15,13 +15,13 @@ info:
 
     Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.
 
-    | Name                               | Type   | Required | Description |
+    | Name                               | Type   | Required | Description                                                                                                                                                                          |
     | ---------------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-    | Authorization                      | String | Yes      | Bearer API KEY |
-    | x-apideck-app-id                   | String | Yes      | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |
+    | Authorization                      | String | Yes      | Bearer API KEY                                                                                                                                                                       |
+    | x-apideck-app-id                   | String | Yes      | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.                                                                                   |
     | x-apideck-consumer-id              | String | Yes      | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.                       |
-    | x-apideck-downstream-url           | String | Yes      | Downstream URL to forward the request too |
-    | x-apideck-downstream-authorization | String | No       | Downstream authorization header. This will skip the Vault token injection. |
+    | x-apideck-downstream-url           | String | Yes      | Downstream URL to forward the request too                                                                                                                                            |
+    | x-apideck-downstream-authorization | String | No       | Downstream authorization header. This will skip the Vault token injection.                                                                                                           |
     | x-apideck-downstream-method        | String | No       | Downstream method. If not provided the upstream method will be inherited, depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT. |
     | x-apideck-service-id               | String | No       | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.                                   |
 
@@ -59,7 +59,7 @@ info:
 
     ## Static IP
 
-    Some of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to the Proxy API with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers.
+    Some of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers.
     To use this feature, the API Vendor will need to whitelist the associated static IP addresses.
     The provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.
 
@@ -88,28 +88,24 @@ info:
     < {{responseBody}}
     ```
 
-    ## SDKs and API Clients
-
-    Upcoming. [Request the SDK of your choice](https://integrations.apideck.com/request).
-
     ## Errors
 
     The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.
 
-    | Code | Title                | Description |
+    | Code | Title                | Description                                                                                                                                                                                              |
     | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | 200  | OK                   | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.                                |
-    | 201  | Created              | The request has been fulfilled and has resulted in one or more new resources being created. |
-    | 204  | No Content           | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |
+    | 201  | Created              | The request has been fulfilled and has resulted in one or more new resources being created.                                                                                                              |
+    | 204  | No Content           | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.                                                                          |
     | 400  | Bad Request          | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |
-    | 401  | Unauthorized         | The request has not been applied because it lacks valid authentication credentials for the target resource. |
-    | 402  | Payment Required     | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. |
-    | 403  | Forbidden            | You do not have the appropriate user rights to access the request. Do not repeat the request. |
-    | 404  | Not Found            | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. |
-    | 409  | Conflict             | The request could not be completed due to a conflict with the current state of the target resource. |
+    | 401  | Unauthorized         | The request has not been applied because it lacks valid authentication credentials for the target resource.                                                                                              |
+    | 402  | Payment Required     | Subscription data is incomplete or out of date. You'll need to provide payment details to continue.                                                                                                      |
+    | 403  | Forbidden            | You do not have the appropriate user rights to access the request. Do not repeat the request.                                                                                                            |
+    | 404  | Not Found            | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.                                                                           |
+    | 409  | Conflict             | The request could not be completed due to a conflict with the current state of the target resource.                                                                                                      |
     | 422  | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.                                     |
-    | 429  | Too Many Requests    | You sent too many requests in a given amount of time ("rate limit"). Try again later. |
-    | 5xx  | Server Errors        | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. |
+    | 429  | Too Many Requests    | You sent too many requests in a given amount of time ("rate limit"). Try again later.                                                                                                                    |
+    | 5xx  | Server Errors        | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.                                                                             |
 
     ### Handling errors
 
@@ -147,7 +143,7 @@ info:
 
     #### RequestLimitError
 
-    You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately.
+    You have reached the number of requests included in your Free Tier Subscription. You will not be able to make further requests until you upgrade your subscription. Please reach out to sales@apideck.com to continue making requests.
 
     #### EntityNotFoundError
 

diff --git a/sms.yml b/sms.yml
diff --git a/vault.yml b/vault.yml
@@ -68,8 +68,6 @@ info:
 
     ![](https://developers.apideck.com/api-references/vault/connection-flow.png)
 
-    More information about the connection state can be found in the [Connection state](https://developers.apideck.com/guides/connection-states) guide.
-
     ## Unify and Proxy integration
 
     The only thing you need to use the Unify APIs and Proxy is the consumer id; thereafter, Vault will do the look-up in the background to handle the token injection before performing the API call(s).
@@ -78,20 +76,16 @@ info:
 
     Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.
 
-    | Name                  | Type    | Required | Description |
+    | Name                  | Type    | Required | Description                                                                                                                                                    |
     | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-    | x-apideck-app-id      | String  | Yes      | The id of your Unify application. Available at https://app.apideck.com/api-keys. |
+    | x-apideck-app-id      | String  | Yes      | The id of your Unify application. Available at https://app.apideck.com/api-keys.                                                                               |
     | x-apideck-consumer-id | String  | Yes      | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |
-    | x-apideck-raw         | Boolean | No       | Include raw response. Mostly used for debugging purposes. |
+    | x-apideck-raw         | Boolean | No       | Include raw response. Mostly used for debugging purposes.                                                                                                      |
 
     ## Guides
 
-    - [Get started with Apideck](https://developers.apideck.com/getting-started)
-    - [Get started with Vault](https://developers.apideck.com/guides/vault)
-    - [Authorize connection via Vault](https://developers.apideck.com/guides/authorize-connections)
-    - [Vault connection status](https://developers.apideck.com/guides/connection-states)
     - [How to build an integrations UI with Vault](https://github.com/apideck-samples/integration-settings)
-
+    - How to configure the OAuth credentials for integration providers (COMING SOON)
 
     ## FAQ
 
@@ -104,7 +98,7 @@ info:
 
     ### How do I migrate existing data?
 
-    Using our migration API, you can migrate the access tokens and accounts to Apideck Vault.
+    Using our migration API, you can migrate the access tokens and accounts to Apideck Vault. (COMING SOON)
 
     ### Can I use Vault in combination with existing integrations?
 
@@ -121,13 +115,13 @@ info:
 
     - Vault API
     - Hosted Vault
-    - Vault Widget (JS, React, Vue)
+    - Apideck Ecosystem _(COMING SOON)_
 
     You can also opt to bypass Vault and still take care of authentication flows yourself. Make sure to put the right safeguards in place to protect your customers' tokens and other sensitive data.
 
     ### What auth types does Vault support?
 
-    We support all the common authentication types, including: API keys, OAuth, Basic auth, and more.
+    What auth strategies does Vault handle? We currently support three flows so your customers can activate an integration.
 
     #### API keys
 

diff --git a/webhook.yml b/webhook.yml