@unified-api/typescript-sdk 1.0.0 → 1.0.1

package/docs/sdks/document/README.md

@@ -1,309 +0,0 @@
-# Document
-(*document*)
-
-### Available Operations
-
-* [createAtsDocument](#createatsdocument) - Create a document
-* [getAtsDocument](#getatsdocument) - Retrieve a document
-* [listAtsDocuments](#listatsdocuments) - List all documents
-* [patchAtsDocument](#patchatsdocument) - Update a document
-* [removeAtsDocument](#removeatsdocument) - Remove a document
-* [updateAtsDocument](#updateatsdocument) - Update a document
-
-## createAtsDocument
-
-Create a document
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { AtsDocumentType } 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.document.createAtsDocument({
-    atsDocument: {
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.CreateAtsDocumentRequest](../../sdk/models/operations/createatsdocumentrequest.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.CreateAtsDocumentResponse](../../sdk/models/operations/createatsdocumentresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## getAtsDocument
-
-Retrieve a document
-
-### 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.document.getAtsDocument({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                | Type                                                                                     | Required                                                                                 | Description                                                                              |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `request`                                                                                | [operations.GetAtsDocumentRequest](../../sdk/models/operations/getatsdocumentrequest.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.GetAtsDocumentResponse](../../sdk/models/operations/getatsdocumentresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## listAtsDocuments
-
-List all documents
-
-### 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.document.listAtsDocuments({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.ListAtsDocumentsRequest](../../sdk/models/operations/listatsdocumentsrequest.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.ListAtsDocumentsResponse](../../sdk/models/operations/listatsdocumentsresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## patchAtsDocument
-
-Update a document
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { AtsDocumentType } 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.document.patchAtsDocument({
-    atsDocument: {
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.PatchAtsDocumentRequest](../../sdk/models/operations/patchatsdocumentrequest.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.PatchAtsDocumentResponse](../../sdk/models/operations/patchatsdocumentresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## removeAtsDocument
-
-Remove a document
-
-### 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.document.removeAtsDocument({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.RemoveAtsDocumentRequest](../../sdk/models/operations/removeatsdocumentrequest.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.RemoveAtsDocumentResponse](../../sdk/models/operations/removeatsdocumentresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## updateAtsDocument
-
-Update a document
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { AtsDocumentType } 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.document.updateAtsDocument({
-    atsDocument: {
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.UpdateAtsDocumentRequest](../../sdk/models/operations/updateatsdocumentrequest.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.UpdateAtsDocumentResponse](../../sdk/models/operations/updateatsdocumentresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |

package/docs/sdks/employee/README.md

@@ -1,363 +0,0 @@
-# Employee
-(*employee*)
-
-### Available Operations
-
-* [createHrisEmployee](#createhrisemployee) - Create an employee
-* [getHrisEmployee](#gethrisemployee) - Retrieve an employee
-* [listHrisEmployees](#listhrisemployees) - List all employees
-* [patchHrisEmployee](#patchhrisemployee) - Update an employee
-* [removeHrisEmployee](#removehrisemployee) - Remove an employee
-* [updateHrisEmployee](#updatehrisemployee) - Update an employee
-
-## createHrisEmployee
-
-Create an employee
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import {
-  EmploymentStatus,
-  HrisEmailType,
-  HrisEmployeeEmploymentType,
-  HrisEmployeeGender,
-  HrisTelephoneType,
-  MaritalStatus,
-} 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.employee.createHrisEmployee({
-    hrisEmployee: {
-      address: {},
-      emails: [
-        {
-          email: "Adriel_Hansen@hotmail.com",
-        },
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      telephones: [
-        {
-          telephone: "<value>",
-        },
-      ],
-    },
-    connectionId: "<value>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.CreateHrisEmployeeRequest](../../sdk/models/operations/createhrisemployeerequest.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.CreateHrisEmployeeResponse](../../sdk/models/operations/createhrisemployeeresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## getHrisEmployee
-
-Retrieve an employee
-
-### 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.employee.getHrisEmployee({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                  | Type                                                                                       | Required                                                                                   | Description                                                                                |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request`                                                                                  | [operations.GetHrisEmployeeRequest](../../sdk/models/operations/gethrisemployeerequest.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.GetHrisEmployeeResponse](../../sdk/models/operations/gethrisemployeeresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## listHrisEmployees
-
-List all employees
-
-### 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.employee.listHrisEmployees({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.ListHrisEmployeesRequest](../../sdk/models/operations/listhrisemployeesrequest.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.ListHrisEmployeesResponse](../../sdk/models/operations/listhrisemployeesresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## patchHrisEmployee
-
-Update an employee
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import {
-  EmploymentStatus,
-  HrisEmailType,
-  HrisEmployeeEmploymentType,
-  HrisEmployeeGender,
-  HrisTelephoneType,
-  MaritalStatus,
-} 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.employee.patchHrisEmployee({
-    hrisEmployee: {
-      address: {},
-      emails: [
-        {
-          email: "Zetta.Cassin@yahoo.com",
-        },
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      telephones: [
-        {
-          telephone: "<value>",
-        },
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.PatchHrisEmployeeRequest](../../sdk/models/operations/patchhrisemployeerequest.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.PatchHrisEmployeeResponse](../../sdk/models/operations/patchhrisemployeeresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## removeHrisEmployee
-
-Remove an employee
-
-### 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.employee.removeHrisEmployee({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.RemoveHrisEmployeeRequest](../../sdk/models/operations/removehrisemployeerequest.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.RemoveHrisEmployeeResponse](../../sdk/models/operations/removehrisemployeeresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-## updateHrisEmployee
-
-Update an employee
-
-### Example Usage
-
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import {
-  EmploymentStatus,
-  HrisEmailType,
-  HrisEmployeeEmploymentType,
-  HrisEmployeeGender,
-  HrisTelephoneType,
-  MaritalStatus,
-} 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.employee.updateHrisEmployee({
-    hrisEmployee: {
-      address: {},
-      emails: [
-        {
-          email: "Abbie_Aufderhar@gmail.com",
-        },
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      telephones: [
-        {
-          telephone: "<value>",
-        },
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.UpdateHrisEmployeeRequest](../../sdk/models/operations/updatehrisemployeerequest.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.UpdateHrisEmployeeResponse](../../sdk/models/operations/updatehrisemployeeresponse.md)>**
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |