boldsign 1.0.0-beta.1

package/.openapi-generator/FILES

@@ -0,0 +1,137 @@
+.gitignore
+LICENSE
+README.md
+api.ts
+api/apis.ts
+api/brandingApi.ts
+api/contactsApi.ts
+api/customFieldApi.ts
+api/documentApi.ts
+api/index.ts
+api/planApi.ts
+api/senderIdentitiesApi.ts
+api/teamsApi.ts
+api/templateApi.ts
+api/userApi.ts
+git_push.sh
+model/accessCodeDetail.ts
+model/accessCodeDetails.ts
+model/attachmentInfo.ts
+model/auditTrail.ts
+model/behalfDocument.ts
+model/behalfDocumentRecords.ts
+model/behalfOf.ts
+model/billingViewModel.ts
+model/brandCreated.ts
+model/brandCustomFieldDetails.ts
+model/brandingMessage.ts
+model/brandingRecords.ts
+model/changeRecipient.ts
+model/conditionalRule.ts
+model/contactCreated.ts
+model/contactDetails.ts
+model/contactPageDetails.ts
+model/contactsDetails.ts
+model/contactsList.ts
+model/createContactResponse.ts
+model/createSenderIdentityRequest.ts
+model/createTeamRequest.ts
+model/createTemplateRequest.ts
+model/createUser.ts
+model/customDomainSettings.ts
+model/customFieldCollection.ts
+model/customFieldMessage.ts
+model/customFormField.ts
+model/deleteCustomFieldReply.ts
+model/document.ts
+model/documentCC.ts
+model/documentCcDetails.ts
+model/documentCreated.ts
+model/documentExpirySettings.ts
+model/documentFiles.ts
+model/documentFormFields.ts
+model/documentInfo.ts
+model/documentProperties.ts
+model/documentReassign.ts
+model/documentRecords.ts
+model/documentSenderDetail.ts
+model/documentSigner.ts
+model/documentSignerDetails.ts
+model/documentTags.ts
+model/editSenderIdentityRequest.ts
+model/editTemplateRequest.ts
+model/editableDateFieldSettings.ts
+model/embeddedCreateTemplateRequest.ts
+model/embeddedCustomFieldCreated.ts
+model/embeddedDocumentRequest.ts
+model/embeddedSendCreated.ts
+model/embeddedSendTemplateFormRequest.ts
+model/embeddedSigningLink.ts
+model/embeddedTemplateCreated.ts
+model/embeddedTemplateEditRequest.ts
+model/embeddedTemplateEdited.ts
+model/errorResult.ts
+model/existingFormField.ts
+model/extendExpiry.ts
+model/fileInfo.ts
+model/font.ts
+model/formField.ts
+model/formGroup.ts
+model/formulaFieldSettings.ts
+model/idVerification.ts
+model/identityVerificationSettings.ts
+model/imageInfo.ts
+model/index.ts
+model/mergeAndSendForSignForm.ts
+model/models.ts
+model/notificationSettings.ts
+model/pageDetails.ts
+model/phoneNumber.ts
+model/prefillField.ts
+model/prefillFieldRequest.ts
+model/problemDetails.ts
+model/recipientNotificationSettings.ts
+model/rectangle.ts
+model/reminderMessage.ts
+model/reminderSettings.ts
+model/removeAuthentication.ts
+model/revokeDocument.ts
+model/role.ts
+model/roles.ts
+model/sendForSign.ts
+model/sendForSignFromTemplateForm.ts
+model/senderIdentityList.ts
+model/senderIdentityViewModel.ts
+model/size.ts
+model/teamCreated.ts
+model/teamDocumentRecords.ts
+model/teamListResponse.ts
+model/teamPageDetails.ts
+model/teamResponse.ts
+model/teamUpdateRequest.ts
+model/teamUsers.ts
+model/teams.ts
+model/template.ts
+model/templateCC.ts
+model/templateCreated.ts
+model/templateFormFields.ts
+model/templateProperties.ts
+model/templateRecords.ts
+model/templateRole.ts
+model/templateSenderDetail.ts
+model/templateSenderDetails.ts
+model/templateSharedTemplateDetail.ts
+model/templateSignerDetails.ts
+model/templateTag.ts
+model/textTagDefinition.ts
+model/textTagOffset.ts
+model/updateUser.ts
+model/userPageDetails.ts
+model/userProperties.ts
+model/userRecords.ts
+model/usersDetails.ts
+model/validation.ts
+model/viewBrandDetails.ts
+model/viewCustomFieldDetails.ts
+package.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.8.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 BoldSign by Syncfusion Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# boldsign
+
+Easily integrate BoldSign's e-signature features into your Node.js applications. This package simplifies sending documents for signature, embedding signing ceremonies, tracking document status, downloading signed documents, and managing e-signature workflows.
+
+## Prerequisites
+
+* Node 12 or higher.
+* Free [developer account](https://boldsign.com/esignature-api/)
+
+## Documentation
+
+* [Official API documentation](https://developers.boldsign.com/)
+
+## Installation
+
+```
+npm install boldsign
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation) and then run the following:
+
+
+### TypeScript Example
+
+```typescript
+import { DocumentApi } from 'boldsign';
+import { DocumentSigner, FormField, Rectangle, SendForSign } from 'boldsign';
+import * as fs from 'fs';
+
+const documentApi = new DocumentApi();
+documentApi.setApiKey('YOUR_API_KEY_HERE');
+
+const bounds = new Rectangle();
+bounds.x = 100;
+bounds.y = 50;
+bounds.width = 100;
+bounds.height = 100;
+
+const formField = new FormField();
+formField.fieldType = FormField.FieldTypeEnum.Signature;
+formField.pageNumber = 1;
+formField.bounds = bounds;
+
+const documentSigner = new DocumentSigner();
+documentSigner.name = "David";
+documentSigner.emailAddress = "david@example.com";
+documentSigner.signerType = DocumentSigner.SignerTypeEnum.Signer;
+documentSigner.formFields = [formField];
+
+var files = fs.createReadStream("agreement.pdf");
+
+const sendForSign = new SendForSign();
+sendForSign.title = "Agreement";
+sendForSign.signers = [documentSigner];
+sendForSign.files = [files];
+
+const sendDocumentResponse = await documentApi.sendDocument(sendForSign);
+
+```

package/api/apis.ts

@@ -0,0 +1,162 @@
+import * as http from 'http';
+import { ErrorResult } from "../model";
+
+export class HttpError extends Error {
+    constructor (public response: AxiosResponse, public body: ErrorResult, public statusCode?: number) {
+        super('HTTP request failed');
+        this.name = 'HttpError';
+    }
+}
+
+export { RequestFile } from '../model';
+
+
+import { AxiosResponse } from "axios";
+import { AttributeTypeMap, ObjectSerializer, RequestDetailedFile } from "../model";
+const formData = require("form-data");
+const Qs = require("qs");
+
+export interface optionsI { headers: { [name: string]: string } }
+export interface returnTypeT<T> { response: AxiosResponse, body: T }
+export interface returnTypeI { response: AxiosResponse, body?: any }
+
+export const queryParamsSerializer = (params) => {
+    return Qs.stringify(params, { arrayFormat: 'brackets' })
+}
+
+export const USER_AGENT = "OpenAPI-Generator/1.8.0/node";
+
+/**
+ * Generates an object containing form data.
+ *
+ * Data is converted to JSON and added to data.body
+ *
+ * @param obj
+ * @param typemap
+ */
+export const generateFormData = (
+  obj: any,
+  typemap: any
+): { localVarUseFormData: boolean; data: object } => {
+  const data = {};
+  let localVarUseFormData = false;
+
+  let attributeTypeMap;
+
+  // Check if the dataType is an Array and get the element type if necessary
+  if (Array.isArray(typemap)) {
+    const itemType = typemap[0]?.constructor;
+    if (itemType && itemType.attributeTypeMap) {
+      attributeTypeMap = itemType.attributeTypeMap;
+    }
+  } else if (typemap && typemap.attributeTypeMap) {
+    attributeTypeMap = typemap.attributeTypeMap;
+  }
+
+  if (typeof obj !== "object" || Array.isArray(obj) || obj === null) {
+    return {
+      localVarUseFormData,
+      data,
+    };
+  }
+
+  attributeTypeMap.forEach((paramInfo) => {
+    if (obj[paramInfo.name] === undefined) {
+      return;
+    }
+
+    /**
+     * Everything except binary (file) data can be serialized to JSON.
+     * If file data we want to keep as-is.
+     */
+    if (paramInfo.type.indexOf("RequestFile") !== -1) {
+      localVarUseFormData = true;
+
+      /**
+       * Some parameters can be arrays of files
+       */
+      if (Array.isArray(obj[paramInfo.name])) {
+        const fileList: any= [];
+        obj[paramInfo.name].forEach((childObject, i) => {
+            fileList.push(childObject);
+        });
+        data[paramInfo.name] = fileList;
+        return;
+      }
+
+      /**
+       * File is already a type of `RequestFile`
+       * @see RequestFile
+       */
+      data[paramInfo.baseName] = obj[paramInfo.name];
+      return;
+    }
+
+    if(paramInfo.type.indexOf("Array") !== -1) {
+      const serializedArray: string[] = [];
+      obj[paramInfo.name].forEach((childObject, i) => {
+        const key = `${paramInfo.baseName}[${i}]`;
+        const serializedItem = JSON.stringify(childObject);
+        serializedArray.push(serializedItem);
+      });
+      data[paramInfo.baseName] = serializedArray;
+      return;
+    }
+
+    // Convert boolean value into string when using FormData, to prevent "data should be a string, Buffer or Uint8Array" error
+    if (paramInfo.type.indexOf("boolean") !== -1) {
+      data[paramInfo.baseName] = JSON.stringify(obj[paramInfo.name]);
+      return;
+    }
+
+    /**
+     * Everything else that is not binary data (file uploads) can be
+     * serialized to JSON and sent over. This helps reduce complexity
+     * when trying to keep formdata key names and serializing each nested
+     * object individually.
+     */
+    const serialized = ObjectSerializer.serialize(
+      obj[paramInfo.name],
+      paramInfo.type
+    );
+
+    data[paramInfo.baseName] = shouldJsonify(serialized)
+      ? JSON.stringify(serialized)
+      : serialized;
+  });
+
+  return {
+    localVarUseFormData,
+    data,
+  };
+};
+
+export const toFormData = (obj: object): any => {
+  const form = new formData();
+
+  Object.keys(obj).forEach((key) => {
+    if (isBufferDetailedFile(obj[key])) {
+      form.append(key, obj[key].value, obj[key].options);
+      return;
+    }
+    else if (Array.isArray(obj[key])) {
+      obj[key].forEach(function (item, index) {
+        form.append(key, item);
+      });
+    } else {
+      form.append(key, obj[key]);
+    }
+  });
+
+  return form;
+};
+
+function isBufferDetailedFile(obj: any): obj is RequestDetailedFile {
+  return (<RequestDetailedFile>obj).value !== undefined
+    && Buffer.isBuffer(obj.value)
+    && (<RequestDetailedFile>obj).options !== undefined
+    && (<RequestDetailedFile>obj).options?.filename !== undefined
+    && (<RequestDetailedFile>obj).options?.contentType !== undefined
+}
+
+const shouldJsonify = (val: any): boolean => val === Object(val);