npm - @unified-api/typescript-sdk - Versions diffs - 1.0.0 → 1.0.1 - Mend

@unified-api/typescript-sdk 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (193) hide show

package/docs/sdks/taxrate/README.md DELETED Viewed

@@ -1,312 +0,0 @@
-# Taxrate
-(*taxrate*)
-### Available Operations
-* [createAccountingTaxrate](#createaccountingtaxrate) - Create a taxrate
-* [getAccountingTaxrate](#getaccountingtaxrate) - Retrieve a taxrate
-* [listAccountingTaxrates](#listaccountingtaxrates) - List all taxrates
-* [patchAccountingTaxrate](#patchaccountingtaxrate) - Update a taxrate
-* [removeAccountingTaxrate](#removeaccountingtaxrate) - Remove a taxrate
-* [updateAccountingTaxrate](#updateaccountingtaxrate) - Update a taxrate
-## createAccountingTaxrate
-Create a taxrate
-### 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.taxrate.createAccountingTaxrate({
-    accountingTaxrate: {
-      name: "<value>",
-      rate: 1719.1,
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                  | [operations.CreateAccountingTaxrateRequest](../../sdk/models/operations/createaccountingtaxraterequest.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.CreateAccountingTaxrateResponse](../../sdk/models/operations/createaccountingtaxrateresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## getAccountingTaxrate
-Retrieve a taxrate
-### 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.taxrate.getAccountingTaxrate({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.GetAccountingTaxrateRequest](../../sdk/models/operations/getaccountingtaxraterequest.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.GetAccountingTaxrateResponse](../../sdk/models/operations/getaccountingtaxrateresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## listAccountingTaxrates
-List all taxrates
-### 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.taxrate.listAccountingTaxrates({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                | [operations.ListAccountingTaxratesRequest](../../sdk/models/operations/listaccountingtaxratesrequest.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.ListAccountingTaxratesResponse](../../sdk/models/operations/listaccountingtaxratesresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## patchAccountingTaxrate
-Update a taxrate
-### 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.taxrate.patchAccountingTaxrate({
-    accountingTaxrate: {
-      name: "<value>",
-      rate: 5991.47,
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                | [operations.PatchAccountingTaxrateRequest](../../sdk/models/operations/patchaccountingtaxraterequest.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.PatchAccountingTaxrateResponse](../../sdk/models/operations/patchaccountingtaxrateresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## removeAccountingTaxrate
-Remove a taxrate
-### 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.taxrate.removeAccountingTaxrate({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                  | [operations.RemoveAccountingTaxrateRequest](../../sdk/models/operations/removeaccountingtaxraterequest.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.RemoveAccountingTaxrateResponse](../../sdk/models/operations/removeaccountingtaxrateresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## updateAccountingTaxrate
-Update a taxrate
-### 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.taxrate.updateAccountingTaxrate({
-    accountingTaxrate: {
-      name: "<value>",
-      rate: 3382.78,
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                  | [operations.UpdateAccountingTaxrateRequest](../../sdk/models/operations/updateaccountingtaxraterequest.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.UpdateAccountingTaxrateResponse](../../sdk/models/operations/updateaccountingtaxrateresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |

package/docs/sdks/ticket/README.md DELETED Viewed

@@ -1,318 +0,0 @@
-# Ticket
-(*ticket*)
-### Available Operations
-* [createTicketingTicket](#createticketingticket) - Create a ticket
-* [getTicketingTicket](#getticketingticket) - Retrieve a ticket
-* [listTicketingTickets](#listticketingtickets) - List all tickets
-* [patchTicketingTicket](#patchticketingticket) - Update a ticket
-* [removeTicketingTicket](#removeticketingticket) - Remove a ticket
-* [updateTicketingTicket](#updateticketingticket) - Update a ticket
-## createTicketingTicket
-Create a ticket
-### Example Usage
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { TicketingTicketStatus } 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.ticket.createTicketingTicket({
-    ticketingTicket: {
-      raw: {
-        "key": "<value>",
-      },
-      tags: [
-        "<value>",
-      ],
-    },
-    connectionId: "<value>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.CreateTicketingTicketRequest](../../sdk/models/operations/createticketingticketrequest.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.CreateTicketingTicketResponse](../../sdk/models/operations/createticketingticketresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## getTicketingTicket
-Retrieve a ticket
-### 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.ticket.getTicketingTicket({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.GetTicketingTicketRequest](../../sdk/models/operations/getticketingticketrequest.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.GetTicketingTicketResponse](../../sdk/models/operations/getticketingticketresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## listTicketingTickets
-List all tickets
-### 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.ticket.listTicketingTickets({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.ListTicketingTicketsRequest](../../sdk/models/operations/listticketingticketsrequest.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.ListTicketingTicketsResponse](../../sdk/models/operations/listticketingticketsresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## patchTicketingTicket
-Update a ticket
-### Example Usage
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { TicketingTicketStatus } 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.ticket.patchTicketingTicket({
-    ticketingTicket: {
-      raw: {
-        "key": "<value>",
-      },
-      tags: [
-        "<value>",
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.PatchTicketingTicketRequest](../../sdk/models/operations/patchticketingticketrequest.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.PatchTicketingTicketResponse](../../sdk/models/operations/patchticketingticketresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## removeTicketingTicket
-Remove a ticket
-### 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.ticket.removeTicketingTicket({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.RemoveTicketingTicketRequest](../../sdk/models/operations/removeticketingticketrequest.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.RemoveTicketingTicketResponse](../../sdk/models/operations/removeticketingticketresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## updateTicketingTicket
-Update a ticket
-### Example Usage
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { TicketingTicketStatus } 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.ticket.updateTicketingTicket({
-    ticketingTicket: {
-      raw: {
-        "key": "<value>",
-      },
-      tags: [
-        "<value>",
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.UpdateTicketingTicketRequest](../../sdk/models/operations/updateticketingticketrequest.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.UpdateTicketingTicketResponse](../../sdk/models/operations/updateticketingticketresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |