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

@unified-api/typescript-sdk 1.0.0 → 1.0.2

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 (196) hide show

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

@@ -1,643 +0,0 @@
-# Martech
-(*martech*)
-### Available Operations
-* [createMartechList](#createmartechlist) - Create a list
-* [createMartechMember](#createmartechmember) - Create a member
-* [getMartechList](#getmartechlist) - Retrieve a list
-* [getMartechMember](#getmartechmember) - Retrieve a member
-* [listMartechLists](#listmartechlists) - List all lists
-* [listMartechMembers](#listmartechmembers) - List all members
-* [patchMartechList](#patchmartechlist) - Update a list
-* [patchMartechMember](#patchmartechmember) - Update a member
-* [removeMartechList](#removemartechlist) - Remove a list
-* [removeMartechMember](#removemartechmember) - Remove member
-* [updateMartechList](#updatemartechlist) - Update a list
-* [updateMartechMember](#updatemartechmember) - Update a member
-## createMartechList
-Create a list
-### 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.martech.createMartechList({
-    marketingList: {
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.CreateMartechListRequest](../../sdk/models/operations/createmartechlistrequest.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.CreateMartechListResponse](../../sdk/models/operations/createmartechlistresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## createMartechMember
-Create a member
-### Example Usage
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { MarketingEmailType } 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.martech.createMartechMember({
-    marketingMember: {
-      emails: [
-        {
-          email: "Eldridge.Marvin@gmail.com",
-        },
-      ],
-      listIds: [
-        "<value>",
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      tags: [
-        "<value>",
-      ],
-    },
-    connectionId: "<value>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `request`                                                                                          | [operations.CreateMartechMemberRequest](../../sdk/models/operations/createmartechmemberrequest.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.CreateMartechMemberResponse](../../sdk/models/operations/createmartechmemberresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## getMartechList
-Retrieve a list
-### 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.martech.getMartechList({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                | Type                                                                                     | Required                                                                                 | Description                                                                              |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `request`                                                                                | [operations.GetMartechListRequest](../../sdk/models/operations/getmartechlistrequest.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.GetMartechListResponse](../../sdk/models/operations/getmartechlistresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## getMartechMember
-Retrieve a member
-### 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.martech.getMartechMember({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.GetMartechMemberRequest](../../sdk/models/operations/getmartechmemberrequest.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.GetMartechMemberResponse](../../sdk/models/operations/getmartechmemberresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## listMartechLists
-List all lists
-### 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.martech.listMartechLists({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.ListMartechListsRequest](../../sdk/models/operations/listmartechlistsrequest.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.ListMartechListsResponse](../../sdk/models/operations/listmartechlistsresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## listMartechMembers
-List all members
-### 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.martech.listMartechMembers({
-    connectionId: "<value>",
-    fields: [
-      "<value>",
-    ],
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.ListMartechMembersRequest](../../sdk/models/operations/listmartechmembersrequest.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.ListMartechMembersResponse](../../sdk/models/operations/listmartechmembersresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## patchMartechList
-Update a list
-### 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.martech.patchMartechList({
-    marketingList: {
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.PatchMartechListRequest](../../sdk/models/operations/patchmartechlistrequest.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.PatchMartechListResponse](../../sdk/models/operations/patchmartechlistresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## patchMartechMember
-Update a member
-### Example Usage
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { MarketingEmailType } 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.martech.patchMartechMember({
-    marketingMember: {
-      emails: [
-        {
-          email: "Shana_Boyle@yahoo.com",
-        },
-      ],
-      listIds: [
-        "<value>",
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      tags: [
-        "<value>",
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.PatchMartechMemberRequest](../../sdk/models/operations/patchmartechmemberrequest.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.PatchMartechMemberResponse](../../sdk/models/operations/patchmartechmemberresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## removeMartechList
-Remove a list
-### 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.martech.removeMartechList({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.RemoveMartechListRequest](../../sdk/models/operations/removemartechlistrequest.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.RemoveMartechListResponse](../../sdk/models/operations/removemartechlistresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## removeMartechMember
-Remove member
-### 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.martech.removeMartechMember({
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `request`                                                                                          | [operations.RemoveMartechMemberRequest](../../sdk/models/operations/removemartechmemberrequest.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.RemoveMartechMemberResponse](../../sdk/models/operations/removemartechmemberresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## updateMartechList
-Update a list
-### 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.martech.updateMartechList({
-    marketingList: {
-      raw: {
-        "key": "<value>",
-      },
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.UpdateMartechListRequest](../../sdk/models/operations/updatemartechlistrequest.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.UpdateMartechListResponse](../../sdk/models/operations/updatemartechlistresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-## updateMartechMember
-Update a member
-### Example Usage
-```typescript
-import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { MarketingEmailType } 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.martech.updateMartechMember({
-    marketingMember: {
-      emails: [
-        {
-          email: "Antonette.Kerluke@hotmail.com",
-        },
-      ],
-      listIds: [
-        "<value>",
-      ],
-      raw: {
-        "key": "<value>",
-      },
-      tags: [
-        "<value>",
-      ],
-    },
-    connectionId: "<value>",
-    id: "<id>",
-  });
-  if (res.statusCode == 200) {
-    // handle response
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `request`                                                                                          | [operations.UpdateMartechMemberRequest](../../sdk/models/operations/updatemartechmemberrequest.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.UpdateMartechMemberResponse](../../sdk/models/operations/updatemartechmemberresponse.md)>**
-### Errors
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |