@unified-api/typescript-sdk 1.0.0 → 1.0.2

package/docs/sdks/auth/README.md

@@ -1,103 +0,0 @@
-# Auth
-(*auth*)
-
-### Available Operations
-
-* [getUnifiedIntegrationAuth](#getunifiedintegrationauth) - Create connection indirectly
-* [getUnifiedIntegrationLogin](#getunifiedintegrationlogin) - Sign in a user
-
-## getUnifiedIntegrationAuth
-
-Returns an authorization URL for the specified integration.  Once a successful authorization occurs, a new connection is created.
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { Scopes } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.auth.getUnifiedIntegrationAuth({
-    integrationType: "<value>",
-    scopes: [
-      Scopes.HrisEmployeeWrite,
-    ],
-    workspaceId: "<value>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                      | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
-| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                      | [operations.GetUnifiedIntegrationAuthRequest](../../sdk/models/operations/getunifiedintegrationauthrequest.md) | :heavy_check_mark:                                                                                             | The request object to use for the request.                                                                     |
-| `config`                                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                   | :heavy_minus_sign:                                                                                             | Available config options for making requests.                                                                  |
-
-
-### Response
-
-**Promise<[operations.GetUnifiedIntegrationAuthResponse](../../sdk/models/operations/getunifiedintegrationauthresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## getUnifiedIntegrationLogin
-
-Returns an authentication URL for the specified integration.  Once a successful authentication occurs, the name and email are returned inside a jwt parameter, which is a JSON web token that is base-64 encoded.
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.auth.getUnifiedIntegrationLogin({
-    integrationType: "<value>",
-    workspaceId: "<value>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                        | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
-| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                        | [operations.GetUnifiedIntegrationLoginRequest](../../sdk/models/operations/getunifiedintegrationloginrequest.md) | :heavy_check_mark:                                                                                               | The request object to use for the request.                                                                       |
-| `config`                                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                     | :heavy_minus_sign:                                                                                               | Available config options for making requests.                                                                    |
-
-
-### Response
-
-**Promise<[operations.GetUnifiedIntegrationLoginResponse](../../sdk/models/operations/getunifiedintegrationloginresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |

package/docs/sdks/call/README.md

@@ -1,54 +0,0 @@
-# Call
-(*call*)
-
-### Available Operations
-
-* [listUcCalls](#listuccalls) - List all calls
-
-## listUcCalls
-
-List all calls
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.call.listUcCalls({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `request`                                                                          | [operations.ListUcCallsRequest](../../sdk/models/operations/listuccallsrequest.md) | :heavy_check_mark:                                                                 | The request object to use for the request.                                         |
-| `config`                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                       | :heavy_minus_sign:                                                                 | Available config options for making requests.                                      |
-
-
-### Response
-
-**Promise<[operations.ListUcCallsResponse](../../sdk/models/operations/listuccallsresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |

package/docs/sdks/candidate/README.md

@@ -1,369 +0,0 @@
-# Candidate
-(*candidate*)
-
-### Available Operations
-
-* [createAtsCandidate](#createatscandidate) - Create a candidate
-* [getAtsCandidate](#getatscandidate) - Retrieve a candidate
-* [listAtsCandidates](#listatscandidates) - List all candidates
-* [patchAtsCandidate](#patchatscandidate) - Update a candidate
-* [removeAtsCandidate](#removeatscandidate) - Remove a candidate
-* [updateAtsCandidate](#updateatscandidate) - Update a candidate
-
-## createAtsCandidate
-
-Create a candidate
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { AtsEmailType, AtsTelephoneType, Origin } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.candidate.createAtsCandidate({
-    atsCandidate: {
-      address: {},
-      emails: [
-        {
-          email: "Robin_Feeney@hotmail.com",
-        },
-      ],
-      linkUrls: [
-        "<value>",
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      sources: [
-        "<value>",
-      ],
-      tags: [
-        "<value>",
-      ],
-      telephones: [
-        {
-          telephone: "<value>",
-        },
-      ],
-    },
-    connectionId: "<value>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.CreateAtsCandidateRequest](../../sdk/models/operations/createatscandidaterequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
-
-
-### Response
-
-**Promise<[operations.CreateAtsCandidateResponse](../../sdk/models/operations/createatscandidateresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## getAtsCandidate
-
-Retrieve a candidate
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.candidate.getAtsCandidate({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                  | Type                                                                                       | Required                                                                                   | Description                                                                                |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request`                                                                                  | [operations.GetAtsCandidateRequest](../../sdk/models/operations/getatscandidaterequest.md) | :heavy_check_mark:                                                                         | The request object to use for the request.                                                 |
-| `config`                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                               | :heavy_minus_sign:                                                                         | Available config options for making requests.                                              |
-
-
-### Response
-
-**Promise<[operations.GetAtsCandidateResponse](../../sdk/models/operations/getatscandidateresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## listAtsCandidates
-
-List all candidates
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.candidate.listAtsCandidates({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.ListAtsCandidatesRequest](../../sdk/models/operations/listatscandidatesrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
-| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
-
-
-### Response
-
-**Promise<[operations.ListAtsCandidatesResponse](../../sdk/models/operations/listatscandidatesresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## patchAtsCandidate
-
-Update a candidate
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { AtsEmailType, AtsTelephoneType, Origin } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.candidate.patchAtsCandidate({
-    atsCandidate: {
-      address: {},
-      emails: [
-        {
-          email: "Tracy.Collins13@gmail.com",
-        },
-      ],
-      linkUrls: [
-        "<value>",
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      sources: [
-        "<value>",
-      ],
-      tags: [
-        "<value>",
-      ],
-      telephones: [
-        {
-          telephone: "<value>",
-        },
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.PatchAtsCandidateRequest](../../sdk/models/operations/patchatscandidaterequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
-| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
-
-
-### Response
-
-**Promise<[operations.PatchAtsCandidateResponse](../../sdk/models/operations/patchatscandidateresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## removeAtsCandidate
-
-Remove a candidate
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.candidate.removeAtsCandidate({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.RemoveAtsCandidateRequest](../../sdk/models/operations/removeatscandidaterequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
-
-
-### Response
-
-**Promise<[operations.RemoveAtsCandidateResponse](../../sdk/models/operations/removeatscandidateresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## updateAtsCandidate
-
-Update a candidate
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { AtsEmailType, AtsTelephoneType, Origin } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
-
-async function run() {
-  const sdk = new UnifiedTo({
-    security: {
-      jwt: "<YOUR_API_KEY_HERE>",
-    },
-  });
-
-  const res = await sdk.candidate.updateAtsCandidate({
-    atsCandidate: {
-      address: {},
-      emails: [
-        {
-          email: "Gaetano86@hotmail.com",
-        },
-      ],
-      linkUrls: [
-        "<value>",
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      sources: [
-        "<value>",
-      ],
-      tags: [
-        "<value>",
-      ],
-      telephones: [
-        {
-          telephone: "<value>",
-        },
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.UpdateAtsCandidateRequest](../../sdk/models/operations/updateatscandidaterequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
-
-
-### Response
-
-**Promise<[operations.UpdateAtsCandidateResponse](../../sdk/models/operations/updateatscandidateresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |