@sinch/fax 0.0.3

package/README.md

@@ -0,0 +1,126 @@
+# Sinch Fax SDK for Node.js
+
+This package contains the Sinch Fax SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one.
+
+<span style="color:red; font-weight:bold">Warning:</span>
+**This SDK is currently available for preview purposes only. It should not be used in production environments.**
+
+## Installation
+
+We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products.
+
+However, it's still possible to use this SDK standalone is you need to access the Fax API only.
+
+### With NPM
+
+```bash
+npm install @sinch/fax
+```
+
+### With Yarn
+
+```bash
+yarn add @sinch/fax
+```
+
+## Usage
+
+### Credentials
+
+The `Fax` API uses the Sinch unified authentication with OAuth2. You will need to provide the following credentials:
+ - projectId: can be found in the [Account Dashboard](https://dashboard.sinch.com/settings/access-keys)
+ - keyId:: can be found in your Access key list in the [Account Dashboard](https://dashboard.sinch.com/settings/access-keys)
+ - keySecret: can be found **ONLY** when generating a new access key: keep it safe!
+
+### As part of the Sinch SDK
+
+If you are using this SDK as part of the Sinch SDK (`@sinch/sdk-core`) you can access it as the `fax` property of the client that you would have instantiated.
+
+```typescript
+import {
+  FaxService,
+  SendFaxRequestData,
+  SinchClient,
+  UnifiedCredentials,
+} from '@sinch/sdk-core';
+
+const credentials: UnifiedCredentials = {
+  projectId: 'PROJECT_ID',
+  keyId: 'KEY_ID',
+  keySecret: 'KEY_SECRET',
+};
+
+// Access the 'fax' service registered on the Sinch Client
+const sinch = new SinchClient(credentials);
+const faxService: FaxService = sinch.fax;
+
+// Build the request data
+const requestData: SendFaxRequestData = {
+  sendFaxRequestBody: {
+    to: '+12015555555',
+    contentUrl: 'https://developers.sinch.com/fax/fax.pdf',
+    callbackUrl: 'https://yourserver/incomingFax',
+  },
+};
+
+// Use the 'fax' service registered on the Sinch client
+const response = await faxService.faxes.send(requestData);
+```
+
+### Standalone
+
+The SDK can be used standalone if you need to use only the Fax APIs.
+
+```typescript
+import {
+  UnifiedCredentials,
+} from '@sinch/sdk-client';
+import {
+  FaxService,
+  SendFaxRequestData,
+} from '@sinch/fax';
+
+const credentials: UnifiedCredentials = {
+  projectId: 'PROJECT_ID',
+  keyId: 'KEY_ID',
+  keySecret: 'KEY_SECRET',
+};
+
+// Declare the 'fax' service in a standalone way
+const faxService = new FaxService(credentials);
+
+// Build the request data
+const requestData: SendFaxRequestData = {
+  sendFaxRequestBody: {
+    to: '+12015555555',
+    contentUrl: 'https://developers.sinch.com/fax/fax.pdf',
+    callbackUrl: 'https://yourserver/incomingFax',
+  },
+};
+
+// Use the standalone declaration of the 'fax' service
+const response = await faxService.faxes.send(requestData);
+```
+
+## Promises
+
+All the methods that interact with the Sinch APIs use Promises. You can use `await` in an `async` method to wait for the response, or you can resolve them yourself with `then()` / `catch()`.
+
+```typescript
+// Method 1: Wait for the Promise to complete (you need to be in an 'async' method)
+let sendFaxResult: Fax;
+try {
+  sendFaxResult = await faxService.faxes.send(requestData);
+  console.log(`Fax successfully created at '${sendFaxResult.createTime}'. Status = '${sendFaxResult.status}`);
+} catch (error: any) {
+  console.error(`ERROR ${error.statusCode}: Impossible to crete the fax sent to ${requestdata.to}.`);
+}
+
+// Method 2: Resolve the promise
+faxService.faxes.send(requestData)
+  .then(response => console.log(`Fax successfully created at '${sendFaxResult.createTime}'. Status = '${sendFaxResult.status}`))
+  .catch(error => console.error(`ERROR ${error.statusCode}: Impossible to crete the fax sent to ${requestdata.to}.`));
+```
+
+## Contact
+Developer Experience team: [devexp@sinch.com](mailto:devexp@sinch.com)

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './models';
+export * from './rest';
+export * from '@sinch/sdk-client';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./models"), exports);
+__exportStar(require("./rest"), exports);
+__exportStar(require("@sinch/sdk-client"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,oDAAkC"}

package/dist/models/index.d.ts

@@ -0,0 +1 @@
+export * from './v3';

package/dist/models/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./v3"), exports);
+//# sourceMappingURL=index.js.map

package/dist/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAqB"}

package/dist/models/v3/bar-code/bar-code.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sinch will scan all pages of all incoming faxes for Code-128 and DataMatrix bar codes and include this information in webhook requests and via the API.
+ */
+export interface BarCode {
+    /** The type of barcode found. */
+    type?: 'CODE_128' | 'DATA_MATRIX';
+    /** The page number on which the barcode was found. */
+    page?: number;
+    /** The  information of the barcode. */
+    value?: string;
+}

package/dist/models/v3/bar-code/bar-code.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=bar-code.js.map

package/dist/models/v3/bar-code/bar-code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bar-code.js","sourceRoot":"","sources":["../../../../src/models/v3/bar-code/bar-code.ts"],"names":[],"mappings":""}

package/dist/models/v3/bar-code/index.d.ts

@@ -0,0 +1 @@
+export type { BarCode } from './bar-code';

package/dist/models/v3/bar-code/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/bar-code/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/bar-code/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/email/email.d.ts

@@ -0,0 +1,12 @@
+interface EmailBase {
+    email?: string;
+    /** Numbers you want to associate with this email. */
+    phoneNumbers?: string[];
+}
+export interface EmailRequest extends EmailBase {
+}
+export interface Email extends EmailBase {
+    /** The `Id` of the project associated with the call. */
+    projectId?: string;
+}
+export {};

package/dist/models/v3/email/email.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=email.js.map

package/dist/models/v3/email/email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.js","sourceRoot":"","sources":["../../../../src/models/v3/email/email.ts"],"names":[],"mappings":""}

package/dist/models/v3/email/index.d.ts

@@ -0,0 +1 @@
+export type { Email, EmailRequest } from './email';

package/dist/models/v3/email/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/email/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/email/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/enums.d.ts

@@ -0,0 +1,16 @@
+export type ImageConversionMethod = 'HALFTONE' | 'MONOCHROME';
+export type WebhookContentType = 'multipart/form-data' | 'application/json';
+/**
+ * The direction of the fax.
+ */
+export type FaxDirection = 'OUTBOUND' | 'INBOUND';
+/**
+ * The status of the fax
+ */
+export type FaxStatus = 'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILURE';
+/**
+ * Error type
+ */
+export type ErrorType = 'DOCUMENT_CONVERSION_ERROR' | 'CALL_ERROR' | 'FAX_ERROR' | 'FATAL_ERROR' | 'GENERAL_ERROR' | 'LINE_ERROR';
+export type FaxBase64FileType = 'DOC' | 'DOCX' | 'PDF' | 'TIF' | 'JPG' | 'ODT' | 'TXT' | 'HTML' | 'PNG';
+export type FaxWebhookEvent = 'INCOMING_FAX' | 'FAX_COMPLETED';

package/dist/models/v3/enums.js

@@ -0,0 +1,10 @@
+"use strict";
+// export type { TypeEnum as BarCodeTypeEnum } from './bar-code/bar-code';
+// export type { TypeEnum as CallErrorTypeEnum, ErrorCodeEnum as CallErrorErrorCodeEnum } from './call-error/call-error';
+// export type { TypeEnum as DocumentConversionErrorTypeEnum, ErrorCodeEnum as DocumentConversionErrorErrorCodeEnum } from './document-conversion-error/document-conversion-error';
+// export type { CallbackContentTypeEnum as FaxCallbackContentTypeEnum, ImageConversionMethodEnum as FaxImageConversionMethodEnum } from './fax/fax';
+// export type { FileTypeEnum as FaxBase64FileFileTypeEnum } from './fax-base64-file/fax-base64-file';
+// export type { TypeEnum as FaxErrorTypeEnum } from './fax-error/fax-error';
+// export type { CallbackContentTypeEnum as SendFaxRequest1CallbackContentTypeEnum, ImageConversionMethodEnum as SendFaxRequest1ImageConversionMethodEnum } from './send-fax-request1/send-fax-request1';
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=enums.js.map

package/dist/models/v3/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/models/v3/enums.ts"],"names":[],"mappings":";AAAA,0EAA0E;AAC1E,yHAAyH;AACzH,mLAAmL;AACnL,qJAAqJ;AACrJ,sGAAsG;AACtG,6EAA6E;AAC7E,yMAAyM"}

package/dist/models/v3/fax/fax.d.ts

@@ -0,0 +1,62 @@
+import { BarCode } from '../bar-code';
+import { FaxContentUrl } from '../fax-content-url';
+import { FaxMoney } from '../fax-money';
+import { ErrorType, FaxDirection, FaxStatus, ImageConversionMethod, WebhookContentType } from '../enums';
+export interface Fax {
+    /** The id of a fax */
+    id?: string;
+    /** @see FaxDirection */
+    direction?: FaxDirection;
+    /** A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading \'+\'. */
+    from?: string;
+    /** A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading \'+\'. */
+    to?: string;
+    /** @see FaxContentUrl */
+    contentUrl?: FaxContentUrl;
+    /** The number of pages in the fax. */
+    numberOfPages?: number;
+    /** @see FaxStatus */
+    status?: FaxStatus;
+    /** The total price for this fax. This field is populated after the final fax price is calculated. */
+    price?: FaxMoney;
+    /** The bar codes found in the fax. This field is populated when sinch detects bar codes on incoming faxes. */
+    barCodes?: BarCode[];
+    /** A timestamp representing the time when the initial API call was made. */
+    createTime?: Date;
+    /** If the job is complete, this is a timestamp representing the time the job was completed. */
+    completedTime?: Date;
+    /** Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is \"-\". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails. */
+    headerText?: string;
+    /** If true, page numbers will be displayed in the header. Default is true. */
+    headerPageNumbers?: boolean;
+    /** A [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string specifying the timezone for the header timestamp. */
+    headerTimeZone?: string;
+    /** The number of seconds to wait between retries if the fax is not yet completed. */
+    retryDelaySeconds?: number;
+    /** You can use this to attach labels to your call that you can use in your applications. It is a key value store. */
+    labels?: {
+        [key: string]: string;
+    };
+    /** The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the `callbackUrl` parameter, if provided, otherwise it will be sent to the URL specified in the `callbackUrl` field of the Fax Service object. */
+    callbackUrl?: string;
+    /** The content type of the callback. */
+    callbackContentType?: WebhookContentType;
+    /** Determines how documents are converted to black and white. Defaults to value selected on Fax Service object. */
+    imageConversionMethod?: ImageConversionMethod;
+    /** @see ErrorType */
+    errorType?: ErrorType;
+    /** One of the error numbers listed in the [Fax Error Messages section](#FaxErrors). */
+    errorId?: number;
+    /** One of the error codes listed in the [Fax Error Messages section](#FaxErrors). */
+    errorCode?: string;
+    /** The `Id` of the project associated with the call. */
+    projectId?: string;
+    /** ID of the fax service used. */
+    serviceId?: string;
+    /** | The number of times the fax will be retired before cancel. Default value is set in your fax service. | The maximum number of retries is 5. */
+    maxRetries?: number;
+    /** The number of times the fax has been retried. */
+    retryCount?: number;
+    /** Only shown on the fax result. This indicates if the content of the fax is stored with Sinch. (true or false) */
+    hasFile?: string;
+}

package/dist/models/v3/fax/fax.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fax.js.map

package/dist/models/v3/fax/fax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fax.js","sourceRoot":"","sources":["../../../../src/models/v3/fax/fax.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax/index.d.ts

@@ -0,0 +1 @@
+export type { Fax } from './fax';

package/dist/models/v3/fax/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/fax/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/fax/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-base64-file/fax-base64-file.d.ts

@@ -0,0 +1,7 @@
+import { FaxBase64FileType } from '../enums';
+export interface FaxBase64File {
+    /** When application/json Base64 encoded file content, this is only present when using application/json for request/response. */
+    file?: string;
+    /** When request/response is application json and file is part of payload. This is the file type of the file. */
+    fileType?: FaxBase64FileType;
+}

package/dist/models/v3/fax-base64-file/fax-base64-file.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fax-base64-file.js.map

package/dist/models/v3/fax-base64-file/fax-base64-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fax-base64-file.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-base64-file/fax-base64-file.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-base64-file/index.d.ts

@@ -0,0 +1 @@
+export type { FaxBase64File } from './fax-base64-file';

package/dist/models/v3/fax-base64-file/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/fax-base64-file/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-base64-file/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-content-url/fax-content-url.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Give us any URL on the Internet (including ones with basic authentication) At least one file or contentUrl parameter is required. Please note: If you are passing fax a secure URL (starting with https://), make sure that your SSL certificate (including your intermediate cert, if you have one) is installed properly, valid, and up-to-date. If the file parameter is specified as well, content from URLs will be rendered before content from files.  You can add multiple URLs by adding them as an array them with a comma when posting as multipart/form-data  For example: \"https://developers.sinch.com/fax/fax.pdf, https://developers.sinch.com/\" or if posting JSON `\"contentUrl\": [\"https://developers.sinch.com/fax/fax.pdf\", \"https://developers.sinch.com/\"]`
+ */
+export type FaxContentUrl = string | string[];

package/dist/models/v3/fax-content-url/fax-content-url.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fax-content-url.js.map

package/dist/models/v3/fax-content-url/fax-content-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fax-content-url.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-content-url/fax-content-url.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-content-url/index.d.ts

@@ -0,0 +1 @@
+export type { FaxContentUrl } from './fax-content-url';

package/dist/models/v3/fax-content-url/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/fax-content-url/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-content-url/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-money/fax-money.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This is where we need description to be overridden by `$ref:` description
+ */
+export interface FaxMoney {
+    /** The 3-letter currency code defined in ISO 4217. */
+    currencyCode?: string;
+    /** The amount with 4 decimals and decimal delimiter `.`. */
+    amount?: string;
+}

package/dist/models/v3/fax-money/fax-money.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fax-money.js.map

package/dist/models/v3/fax-money/fax-money.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fax-money.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-money/fax-money.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-money/index.d.ts

@@ -0,0 +1 @@
+export type { FaxMoney } from './fax-money';

package/dist/models/v3/fax-money/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/fax-money/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-money/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-request/fax-request.d.ts

@@ -0,0 +1,43 @@
+import { ImageConversionMethod, WebhookContentType } from '../enums';
+import { FaxContentUrl } from '../fax-content-url';
+import { FaxBase64File } from '../fax-base64-file';
+export type FaxRequest = FaxRequestJson | FaxRequestFormData;
+interface FaxRequestBase {
+    /** A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading \\\'+\\\'. */
+    to: string;
+    /** A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading \\\'+\\\'. */
+    from?: string;
+    /**  */
+    contentUrl?: FaxContentUrl;
+    /** Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is \\\"-\\\". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails. */
+    headerText?: string;
+    /** If true, page numbers will be displayed in the header. Default is true. */
+    headerPageNumbers?: boolean;
+    /** A [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string specifying the timezone for the header timestamp. */
+    headerTimeZone?: string;
+    /** The number of seconds to wait between retries if the fax is not yet completed. */
+    retryDelaySeconds?: number;
+    /** You can use this to attach labels to your call that you can use in your applications. It is a key value store. */
+    labels?: {
+        [key: string]: string;
+    };
+    /** The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the `callbackUrl` parameter, if provided, otherwise it will be sent to the URL specified in the `callbackUrl` field of the Fax Service object. */
+    callbackUrl?: string;
+    /** The content type of the callback. */
+    callbackContentType?: WebhookContentType;
+    /** Determines how documents are converted to black and white. Defaults to value selected on Fax Service object. */
+    imageConversionMethod?: ImageConversionMethod;
+    /** ID of the fax service used. */
+    serviceId?: string;
+    /** | The number of times the fax will be retired before cancel. Default value is set in your fax service. | The maximum number of retries is 5. */
+    maxRetries?: number;
+}
+export type FaxRequestJson = FaxRequestBase & {
+    /** An array of base64 encoded files */
+    files: FaxBase64File[];
+};
+export interface FaxRequestFormData extends FaxRequestBase {
+    /** The file(s) you want to send as a fax as body attachment. */
+    file?: any;
+}
+export {};

package/dist/models/v3/fax-request/fax-request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fax-request.js.map

package/dist/models/v3/fax-request/fax-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fax-request.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-request/fax-request.ts"],"names":[],"mappings":""}

package/dist/models/v3/fax-request/index.d.ts

@@ -0,0 +1 @@
+export type { FaxRequest, FaxRequestJson, FaxRequestFormData } from './fax-request';

package/dist/models/v3/fax-request/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/fax-request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/fax-request/index.ts"],"names":[],"mappings":""}

package/dist/models/v3/index.d.ts

@@ -0,0 +1,13 @@
+export * from './bar-code';
+export * from './email';
+export * from './fax';
+export * from './fax-base64-file';
+export * from './fax-content-url';
+export * from './fax-money';
+export * from './fax-request';
+export * from './mod-events';
+export * from './service';
+export * from './service-email-settings';
+export * from './service-phone-number';
+export * from './update-email-request';
+export * from './enums';

package/dist/models/v3/index.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// export * from './bad-request-detail';
+__exportStar(require("./bar-code"), exports);
+// export * from './call-error';
+// export * from './document-conversion-error';
+__exportStar(require("./email"), exports);
+// export * from './error';
+// export * from './error-detail';
+// export * from './error-info';
+// export * from './error-type';
+__exportStar(require("./fax"), exports);
+__exportStar(require("./fax-base64-file"), exports);
+__exportStar(require("./fax-content-url"), exports);
+// export * from './fax-error';
+// export * from './fax-errors';
+// export * from './fax-status';
+// export * from './field-violation';
+// export * from './generic-event';
+__exportStar(require("./fax-money"), exports);
+__exportStar(require("./fax-request"), exports);
+__exportStar(require("./mod-events"), exports);
+// export * from './pagination';
+// export * from './quota-failure';
+// export * from './quota-failure-detail';
+// export * from './request-info-detail';
+// export * from './send-fax-request1';
+__exportStar(require("./service"), exports);
+__exportStar(require("./service-email-settings"), exports);
+__exportStar(require("./service-phone-number"), exports);
+__exportStar(require("./update-email-request"), exports);
+__exportStar(require("./enums"), exports);
+//# sourceMappingURL=index.js.map

package/dist/models/v3/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAwC;AACxC,6CAA2B;AAC3B,gCAAgC;AAChC,+CAA+C;AAC/C,0CAAwB;AACxB,2BAA2B;AAC3B,kCAAkC;AAClC,gCAAgC;AAChC,gCAAgC;AAChC,wCAAsB;AACtB,oDAAkC;AAClC,oDAAkC;AAClC,+BAA+B;AAC/B,gCAAgC;AAChC,gCAAgC;AAChC,qCAAqC;AACrC,mCAAmC;AACnC,8CAA4B;AAC5B,gDAA8B;AAC9B,+CAA6B;AAC7B,gCAAgC;AAChC,mCAAmC;AACnC,0CAA0C;AAC1C,yCAAyC;AACzC,uCAAuC;AACvC,4CAA0B;AAC1B,2DAAyC;AACzC,yDAAuC;AACvC,yDAAuC;AACvC,0CAAwB"}

package/dist/models/v3/mod-events/base-fax-event/base-fax-event.d.ts

@@ -0,0 +1,16 @@
+import { Fax } from '../../fax';
+import { FaxWebhookEvent } from '../../enums';
+export interface BaseFaxEvent {
+    /** The different events that can trigger a webhook */
+    event?: FaxWebhookEvent;
+    /** Time of the event. */
+    eventTime?: Date;
+    /** @see Fax */
+    fax?: Fax;
+}
+export interface FaxEventJson extends BaseFaxEvent {
+}
+export interface FaxEventFormData extends BaseFaxEvent {
+    /** The fax content as a PDF attachment to the body.  <application/pdf> */
+    file?: string;
+}

package/dist/models/v3/mod-events/base-fax-event/base-fax-event.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=base-fax-event.js.map

package/dist/models/v3/mod-events/base-fax-event/base-fax-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-fax-event.js","sourceRoot":"","sources":["../../../../../src/models/v3/mod-events/base-fax-event/base-fax-event.ts"],"names":[],"mappings":""}

package/dist/models/v3/mod-events/base-fax-event/index.d.ts

@@ -0,0 +1 @@
+export type { FaxEventJson, FaxEventFormData } from './base-fax-event';

package/dist/models/v3/mod-events/base-fax-event/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map