@apideck/unify 0.20.0 → 0.21.0

package/docs/sdks/pipelines/README.md

@@ -6,6 +6,10 @@
 ### Available Operations
 
 * [list](#list) - List pipelines
+* [create](#create) - Create pipeline
+* [get](#get) - Get pipeline
+* [update](#update) - Update pipeline
+* [delete](#delete) - Delete pipeline
 
 ## list
 
@@ -95,6 +99,634 @@ run();
 
 ### Errors
 
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## create
+
+Create pipeline
+
+### Example Usage
+
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const result = await apideck.crm.pipelines.create({
+    serviceId: "salesforce",
+    pipeline: {
+      id: "default",
+      name: "Sales Pipeline",
+      currency: "USD",
+      archived: false,
+      active: false,
+      displayOrder: 1,
+      winProbabilityEnabled: true,
+      stages: [
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+      ],
+      passThrough: [
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+      ],
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { crmPipelinesCreate } from "@apideck/unify/funcs/crmPipelinesCreate.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const res = await crmPipelinesCreate(apideck, {
+    serviceId: "salesforce",
+    pipeline: {
+      id: "default",
+      name: "Sales Pipeline",
+      currency: "USD",
+      archived: false,
+      active: false,
+      displayOrder: 1,
+      winProbabilityEnabled: true,
+      stages: [
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+      ],
+      passThrough: [
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+      ],
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CrmPipelinesAddRequest](../../models/operations/crmpipelinesaddrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CrmPipelinesAddResponse](../../models/operations/crmpipelinesaddresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## get
+
+Get pipeline
+
+### Example Usage
+
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const result = await apideck.crm.pipelines.get({
+    id: "<id>",
+    serviceId: "salesforce",
+    fields: "id,updated_at",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { crmPipelinesGet } from "@apideck/unify/funcs/crmPipelinesGet.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const res = await crmPipelinesGet(apideck, {
+    id: "<id>",
+    serviceId: "salesforce",
+    fields: "id,updated_at",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CrmPipelinesOneRequest](../../models/operations/crmpipelinesonerequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CrmPipelinesOneResponse](../../models/operations/crmpipelinesoneresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## update
+
+Update pipeline
+
+### Example Usage
+
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const result = await apideck.crm.pipelines.update({
+    id: "<id>",
+    serviceId: "salesforce",
+    pipeline: {
+      id: "default",
+      name: "Sales Pipeline",
+      currency: "USD",
+      archived: false,
+      active: false,
+      displayOrder: 1,
+      winProbabilityEnabled: true,
+      stages: [
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+      ],
+      passThrough: [
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+      ],
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { crmPipelinesUpdate } from "@apideck/unify/funcs/crmPipelinesUpdate.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const res = await crmPipelinesUpdate(apideck, {
+    id: "<id>",
+    serviceId: "salesforce",
+    pipeline: {
+      id: "default",
+      name: "Sales Pipeline",
+      currency: "USD",
+      archived: false,
+      active: false,
+      displayOrder: 1,
+      winProbabilityEnabled: true,
+      stages: [
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+        {
+          name: "Contract Sent",
+          value: "CONTRACT_SENT",
+          winProbability: 50,
+          displayOrder: 1,
+        },
+      ],
+      passThrough: [
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+      ],
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CrmPipelinesUpdateRequest](../../models/operations/crmpipelinesupdaterequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CrmPipelinesUpdateResponse](../../models/operations/crmpipelinesupdateresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## delete
+
+Delete pipeline
+
+### Example Usage
+
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const result = await apideck.crm.pipelines.delete({
+    id: "<id>",
+    serviceId: "salesforce",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { crmPipelinesDelete } from "@apideck/unify/funcs/crmPipelinesDelete.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const res = await crmPipelinesDelete(apideck, {
+    id: "<id>",
+    serviceId: "salesforce",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CrmPipelinesDeleteRequest](../../models/operations/crmpipelinesdeleterequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CrmPipelinesDeleteResponse](../../models/operations/crmpipelinesdeleteresponse.md)\>**
+
+### Errors
+
 | Error Type                     | Status Code                    | Content Type                   |
 | ------------------------------ | ------------------------------ | ------------------------------ |
 | errors.BadRequestResponse      | 400                            | application/json               |