@documenso/sdk-typescript 0.1.1 → 0.1.2

package/docs/sdks/fields/README.md

@@ -1,15 +1,20 @@
 # Fields
-(*fields*)
+(*documents.fields*)
 
 ## Overview
 
 ### Available Operations
 
-* [get](#get) - Get field
+* [get](#get) - Get document field
+* [create](#create) - Create document field
+* [createMany](#createmany) - Create document fields
+* [update](#update) - Update document field
+* [updateMany](#updatemany) - Update document fields
+* [delete](#delete) - Delete document field
 
 ## get
 
-Returns a single field. If you want to retrieve all the fields for a document or template, use the "Get Document" or "Get Template" request.
+Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.
 
 ### Example Usage
 
@@ -21,8 +26,8 @@ const documenso = new Documenso({
 });
 
 async function run() {
-  const result = await documenso.fields.get({
-    fieldId: 7887.42,
+  const result = await documenso.documents.fields.get({
+    fieldId: 8629.15,
   });
 
   // Handle the result
@@ -38,7 +43,7 @@ The standalone function version of this method:
 
 ```typescript
 import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
-import { fieldsGet } from "@documenso/sdk-typescript/funcs/fieldsGet.js";
+import { documentsFieldsGet } from "@documenso/sdk-typescript/funcs/documentsFieldsGet.js";
 
 // Use `DocumensoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,8 +52,8 @@ const documenso = new DocumensoCore({
 });
 
 async function run() {
-  const res = await fieldsGet(documenso, {
-    fieldId: 7887.42,
+  const res = await documentsFieldsGet(documenso, {
+    fieldId: 8629.15,
   });
 
   if (!res.ok) {
@@ -68,14 +73,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.FieldGetFieldRequest](../../models/operations/fieldgetfieldrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.FieldGetDocumentFieldRequest](../../models/operations/fieldgetdocumentfieldrequest.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.FieldGetFieldResponseBody](../../models/operations/fieldgetfieldresponsebody.md)\>**
+**Promise\<[operations.FieldGetDocumentFieldResponseBody](../../models/operations/fieldgetdocumentfieldresponsebody.md)\>**
 
 ### Errors
 
@@ -84,4 +89,480 @@ run();
 | errors.ErrorBADREQUEST          | 400                             | application/json                |
 | errors.ErrorNOTFOUND            | 404                             | application/json                |
 | errors.Errorinternalservererror | 500                             | application/json                |
+| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+
+## create
+
+Create a single field for a document.
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.documents.fields.create({
+    documentId: 4865.89,
+    field: {
+      type: "NUMBER",
+      recipientId: 4174.58,
+      pageNumber: 1343.65,
+      pageX: 690.25,
+      pageY: 7964.74,
+      width: 9510.62,
+      height: 0.86,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsFieldsCreate } from "@documenso/sdk-typescript/funcs/documentsFieldsCreate.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await documentsFieldsCreate(documenso, {
+    documentId: 4865.89,
+    field: {
+      type: "NUMBER",
+      recipientId: 4174.58,
+      pageNumber: 1343.65,
+      pageX: 690.25,
+      pageY: 7964.74,
+      width: 9510.62,
+      height: 0.86,
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.FieldCreateDocumentFieldRequestBody](../../models/operations/fieldcreatedocumentfieldrequestbody.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.FieldCreateDocumentFieldResponseBody](../../models/operations/fieldcreatedocumentfieldresponsebody.md)\>**
+
+### Errors
+
+| Error Type                      | Status Code                     | Content Type                    |
+| ------------------------------- | ------------------------------- | ------------------------------- |
+| errors.ErrorBADREQUEST          | 400                             | application/json                |
+| errors.Errorinternalservererror | 500                             | application/json                |
+| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+
+## createMany
+
+Create multiple fields for a document.
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.documents.fields.createMany({
+    documentId: 5158.41,
+    fields: [
+      {
+        type: "CHECKBOX",
+        recipientId: 2516.72,
+        pageNumber: 2304.17,
+        pageX: 7760.32,
+        pageY: 3376.66,
+        width: 3566.94,
+        height: 2768.94,
+      },
+      {
+        type: "NUMBER",
+        recipientId: 5689.64,
+        pageNumber: 6483.69,
+        pageX: 7271.79,
+        pageY: 1891.56,
+        width: 7263.21,
+        height: 5043.41,
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsFieldsCreateMany } from "@documenso/sdk-typescript/funcs/documentsFieldsCreateMany.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await documentsFieldsCreateMany(documenso, {
+    documentId: 5158.41,
+    fields: [
+      {
+        type: "CHECKBOX",
+        recipientId: 2516.72,
+        pageNumber: 2304.17,
+        pageX: 7760.32,
+        pageY: 3376.66,
+        width: 3566.94,
+        height: 2768.94,
+      },
+      {
+        type: "NUMBER",
+        recipientId: 5689.64,
+        pageNumber: 6483.69,
+        pageX: 7271.79,
+        pageY: 1891.56,
+        width: 7263.21,
+        height: 5043.41,
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.FieldCreateDocumentFieldsRequestBody](../../models/operations/fieldcreatedocumentfieldsrequestbody.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.FieldCreateDocumentFieldsResponseBody](../../models/operations/fieldcreatedocumentfieldsresponsebody.md)\>**
+
+### Errors
+
+| Error Type                      | Status Code                     | Content Type                    |
+| ------------------------------- | ------------------------------- | ------------------------------- |
+| errors.ErrorBADREQUEST          | 400                             | application/json                |
+| errors.Errorinternalservererror | 500                             | application/json                |
+| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+
+## update
+
+Update a single field for a document.
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.documents.fields.update({
+    documentId: 8574.78,
+    field: {
+      type: "TEXT",
+      id: 3446.2,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsFieldsUpdate } from "@documenso/sdk-typescript/funcs/documentsFieldsUpdate.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await documentsFieldsUpdate(documenso, {
+    documentId: 8574.78,
+    field: {
+      type: "TEXT",
+      id: 3446.2,
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.FieldUpdateDocumentFieldRequestBody](../../models/operations/fieldupdatedocumentfieldrequestbody.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.FieldUpdateDocumentFieldResponseBody](../../models/operations/fieldupdatedocumentfieldresponsebody.md)\>**
+
+### Errors
+
+| Error Type                      | Status Code                     | Content Type                    |
+| ------------------------------- | ------------------------------- | ------------------------------- |
+| errors.ErrorBADREQUEST          | 400                             | application/json                |
+| errors.Errorinternalservererror | 500                             | application/json                |
+| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+
+## updateMany
+
+Update multiple fields for a document.
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.documents.fields.updateMany({
+    documentId: 4057.69,
+    fields: [
+      {
+        type: "DATE",
+        id: 8982.15,
+      },
+      {
+        type: "NAME",
+        id: 310.19,
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsFieldsUpdateMany } from "@documenso/sdk-typescript/funcs/documentsFieldsUpdateMany.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await documentsFieldsUpdateMany(documenso, {
+    documentId: 4057.69,
+    fields: [
+      {
+        type: "DATE",
+        id: 8982.15,
+      },
+      {
+        type: "NAME",
+        id: 310.19,
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.FieldUpdateDocumentFieldsRequestBody](../../models/operations/fieldupdatedocumentfieldsrequestbody.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.FieldUpdateDocumentFieldsResponseBody](../../models/operations/fieldupdatedocumentfieldsresponsebody.md)\>**
+
+### Errors
+
+| Error Type                      | Status Code                     | Content Type                    |
+| ------------------------------- | ------------------------------- | ------------------------------- |
+| errors.ErrorBADREQUEST          | 400                             | application/json                |
+| errors.Errorinternalservererror | 500                             | application/json                |
+| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+
+## delete
+
+Delete document field
+
+### Example Usage
+
+```typescript
+import { Documenso } from "@documenso/sdk-typescript";
+
+const documenso = new Documenso({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await documenso.documents.fields.delete({
+    fieldId: 5459.07,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
+import { documentsFieldsDelete } from "@documenso/sdk-typescript/funcs/documentsFieldsDelete.js";
+
+// Use `DocumensoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const documenso = new DocumensoCore({
+  apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await documentsFieldsDelete(documenso, {
+    fieldId: 5459.07,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.FieldDeleteDocumentFieldRequestBody](../../models/operations/fielddeletedocumentfieldrequestbody.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.FieldDeleteDocumentFieldResponseBody](../../models/operations/fielddeletedocumentfieldresponsebody.md)\>**
+
+### Errors
+
+| Error Type                      | Status Code                     | Content Type                    |
+| ------------------------------- | ------------------------------- | ------------------------------- |
+| errors.ErrorBADREQUEST          | 400                             | application/json                |
+| errors.Errorinternalservererror | 500                             | application/json                |
 | errors.APIError                 | 4XX, 5XX                        | \*/\*                           |