@sinch/fax 1.2.1 → 1.4.0

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

@@ -1,9 +1,10 @@
+import { BarCodeType } from '../enums';
 /**
  * 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';
+    type?: BarCodeType;
     /** The page number on which the barcode was found. */
     page?: number;
     /** The  information of the barcode. */

package/dist/models/v3/cover-page/cover-page.d.ts

@@ -0,0 +1,25 @@
+import { CoverPageFile } from '../cover-page-file';
+/**
+ * A cover page creation model
+ */
+export interface CoverPageRequest {
+    /** The friendly name of the cover page. */
+    name: string;
+    /** @see CoverPageFile */
+    file: CoverPageFile;
+}
+/**
+ * A cover page resource
+ */
+export interface CoverPage extends CoverPageRequest {
+    /** ID of the cover page */
+    id?: string;
+    /** The `Id` of the project associated with the call. */
+    projectId?: string;
+    /** ID of the fax service used. */
+    serviceId?: string;
+    /** The date and time the cover page was created. */
+    createdTime?: Date;
+    /** The date and time the cover page was updated. */
+    updatedTime?: Date;
+}

package/dist/models/v3/{service-email-settings/service-email-settings.js → cover-page/cover-page.js}

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

package/dist/models/v3/cover-page/cover-page.js.map

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

package/dist/models/v3/cover-page/index.d.ts

@@ -0,0 +1 @@
+export type { CoverPageRequest, CoverPage } from './cover-page';

package/dist/models/v3/cover-page/index.js

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

package/dist/models/v3/cover-page/index.js.map

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

package/dist/models/v3/cover-page-file/cover-page-file.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A PDF Cover encoded as base64
+ */
+export interface CoverPageFile {
+    /** A PDF Cover encoded as base64 */
+    fileContent: string;
+    /** For now only PDF is supported. */
+    fileType: 'PDF' | string;
+}

package/dist/models/v3/{requests/emails/emails-request-data.js → cover-page-file/cover-page-file.js}

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

package/dist/models/v3/cover-page-file/cover-page-file.js.map

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

package/dist/models/v3/cover-page-file/index.d.ts

@@ -0,0 +1 @@
+export type { CoverPageFile } from './cover-page-file';

package/dist/models/v3/cover-page-file/index.js.map

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

package/dist/models/v3/date-range-filter/date-range-filter.d.ts

@@ -10,8 +10,8 @@ import { DateFormat } from '@sinch/sdk-client';
  * - `from: '2024-02'` will return all faxes for February 2024
  */
 export interface DateRangeFilter {
-    /** */
+    /** Start of the date range */
     from?: string | Date | DateFormat;
-    /** */
+    /** End of the date range */
     to?: string | Date | DateFormat;
 }

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

@@ -1,12 +1,17 @@
+import { NumberWithPermissions } from '../number-with-permissions';
 interface EmailBase {
-    email?: string;
+    email: string;
     /** Numbers you want to associate with this email. */
-    phoneNumbers?: string[];
+    phoneNumbers: NumberWithPermissions[];
 }
 export interface EmailRequest extends EmailBase {
 }
 export interface Email extends EmailBase {
     /** The `Id` of the project associated with the call. */
     projectId?: string;
+    /** The date and time the email was created. */
+    createdAt?: Date;
+    /** The date and time the email was updated. */
+    updatedAt?: Date;
 }
 export {};

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

@@ -1,17 +1,36 @@
-export type ImageConversionMethod = 'HALFTONE' | 'MONOCHROME';
-export type WebhookContentType = 'multipart/form-data' | 'application/json';
+/**
+ * - HALFTONE: Converts the image to halftone.
+ * - MONOCHROME: Converts the image to monochrome.
+ */
+export type ImageConversionMethod = 'HALFTONE' | 'MONOCHROME' | string;
+export type WebhookContentType = 'multipart/form-data' | 'application/json' | string;
 /**
  * The direction of the fax.
  */
-export type FaxDirection = 'OUTBOUND' | 'INBOUND';
+export type FaxDirection = 'OUTBOUND' | 'INBOUND' | string;
 /**
  * The status of the fax
  */
-export type FaxStatus = 'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILURE';
+export type FaxStatus = 'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILURE' | string;
 /**
  * Type of error for the fax
  */
-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 ErrorType = 'DOCUMENT_CONVERSION_ERROR' | 'CALL_ERROR' | 'FAX_ERROR' | 'FATAL_ERROR' | 'GENERAL_ERROR' | 'LINE_ERROR' | string;
+export type FaxBase64FileType = 'DOCX' | 'PDF' | 'TIF' | 'JPG' | 'TXT' | 'HTML' | 'PNG' | string;
 export declare const validBase64FileTypes: FaxBase64FileType[];
-export type FaxWebhookEvent = 'INCOMING_FAX' | 'FAX_COMPLETED';
+export type FaxWebhookEvent = 'INCOMING_FAX' | 'FAX_COMPLETED' | string;
+/**
+ * - CODE_128: Code-128 barcode
+ * - DATA_MATRIX: DataMatrix barcode
+ */
+export type BarCodeType = 'CODE_128' | 'DATA_MATRIX' | string;
+/**
+ * The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.
+ */
+export type Resolution = 'FINE' | 'SUPERFINE' | string;
+/**
+ * - both: 	Allows the email to send and receive faxes to this email/phone number combination.
+ * - send:	Allows the email to only send faxes to this email/phone number combination.
+ * - receive: Allows the email to only receive faxes from this email/phone number combination.
+ */
+export type Permissions = 'both' | 'send' | 'receive' | string;

package/dist/models/v3/enums.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validBase64FileTypes = void 0;
-exports.validBase64FileTypes = ['DOC', 'DOCX', 'PDF', 'TIF', 'JPG', 'ODT', 'TXT', 'HTML', 'PNG'];
+exports.validBase64FileTypes = ['DOCX', 'PDF', 'TIF', 'JPG', 'TXT', 'HTML', 'PNG'];
 //# sourceMappingURL=enums.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/models/v3/enums.ts"],"names":[],"mappings":";;;AA2Ba,QAAA,oBAAoB,GAC7B,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/models/v3/enums.ts"],"names":[],"mappings":";;;AAgCa,QAAA,oBAAoB,GAC7B,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC"}

package/dist/models/v3/errors/call-error/call-error.d.ts

@@ -0,0 +1,13 @@
+/**
+ * There was a problem with the phone line. The call could not be placed. Many times you can just try again
+ */
+export interface CallError {
+    /** Type of error for the Call */
+    errorType?: 'CALL_ERROR';
+    /** A developer-facing error message */
+    errorMessage?: string;
+    /** The error code returned describing the error of the call */
+    errorCode?: CallErrorCodeEnum;
+}
+export type CallErrorCodeEnum = 11 | 15 | 16 | 17 | 19 | 30 | 32 | 34 | 43 | 49 | number;
+export declare const callErrorCodeLabels: Record<CallErrorCodeEnum, string>;

package/dist/models/v3/errors/call-error/call-error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callErrorCodeLabels = void 0;
+exports.callErrorCodeLabels = {
+    11: 'The call dropped prematurely',
+    15: 'Congestion',
+    16: 'Ring Timeout',
+    17: 'Busy',
+    19: 'Immediate Hangup',
+    30: 'No answer from a fax machine.',
+    32: 'Incompatible destination',
+    34: 'Phone number not operational',
+    43: 'Problem establishing connection',
+    49: 'The destination phone number Is Not active',
+};
+//# sourceMappingURL=call-error.js.map

package/dist/models/v3/errors/call-error/call-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-error.js","sourceRoot":"","sources":["../../../../../src/models/v3/errors/call-error/call-error.ts"],"names":[],"mappings":";;;AAca,QAAA,mBAAmB,GAAsC;IACpE,EAAE,EAAE,8BAA8B;IAClC,EAAE,EAAE,YAAY;IAChB,EAAE,EAAE,cAAc;IAClB,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,kBAAkB;IACtB,EAAE,EAAE,+BAA+B;IACnC,EAAE,EAAE,0BAA0B;IAC9B,EAAE,EAAE,8BAA8B;IAClC,EAAE,EAAE,iCAAiC;IACrC,EAAE,EAAE,4CAA4C;CACjD,CAAC"}

package/dist/models/v3/errors/call-error/index.d.ts

@@ -0,0 +1,2 @@
+export type { CallError, CallErrorCodeEnum } from './call-error';
+export { callErrorCodeLabels } from './call-error';

package/dist/models/v3/errors/call-error/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callErrorCodeLabels = void 0;
+var call_error_1 = require("./call-error");
+Object.defineProperty(exports, "callErrorCodeLabels", { enumerable: true, get: function () { return call_error_1.callErrorCodeLabels; } });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/errors/call-error/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v3/errors/call-error/index.ts"],"names":[],"mappings":";;;AACA,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA"}

package/dist/models/v3/errors/document-conversion-error/document-conversion-error.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Conversion errors usually occur when there is a problem with one of the files you posted.
+ */
+export interface DocumentConversionError {
+    /** Type of error for the Document conversion */
+    errorType?: 'DOCUMENT_CONVERSION_ERROR';
+    /** The error message */
+    errorMessage?: string;
+    /** The error code returned during document conversion. */
+    errorCode?: DocumentConversionErrorCodeEnum;
+}
+export type DocumentConversionErrorCodeEnum = 4 | 54 | 55 | 57 | 69 | 122 | 128 | 129 | 130 | 133 | number;
+export declare const documentConversionErrorCodeLabels: Record<DocumentConversionErrorCodeEnum, string>;

package/dist/models/v3/errors/document-conversion-error/document-conversion-error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentConversionErrorCodeLabels = void 0;
+exports.documentConversionErrorCodeLabels = {
+    4: 'There was a problem in converting and merging files to the output file format. Contact support.',
+    54: 'Could not access the url you provided. {contentUrl}',
+    55: 'The string_data URL you provided is invalid',
+    57: 'There was a problem storing the file you provided.',
+    69: 'There was a problem storing the file you provided.',
+    122: 'User simulated Document Conversion Error',
+    128: 'Could not determine mimetype for file.',
+    129: 'Mimetype not supported.',
+    130: 'Mimetype not supported: application/xml',
+    133: 'Failed to normalize PDF document',
+};
+//# sourceMappingURL=document-conversion-error.js.map

package/dist/models/v3/errors/document-conversion-error/document-conversion-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-conversion-error.js","sourceRoot":"","sources":["../../../../../src/models/v3/errors/document-conversion-error/document-conversion-error.ts"],"names":[],"mappings":";;;AAea,QAAA,iCAAiC,GAAoD;IAChG,CAAC,EAAE,iGAAiG;IACpG,EAAE,EAAE,qDAAqD;IACzD,EAAE,EAAE,6CAA6C;IACjD,EAAE,EAAE,oDAAoD;IACxD,EAAE,EAAE,oDAAoD;IACxD,GAAG,EAAE,0CAA0C;IAC/C,GAAG,EAAE,wCAAwC;IAC7C,GAAG,EAAE,yBAAyB;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,GAAG,EAAE,kCAAkC;CACxC,CAAC"}

package/dist/models/v3/errors/document-conversion-error/index.d.ts

@@ -0,0 +1,2 @@
+export type { DocumentConversionError, DocumentConversionErrorCodeEnum } from './document-conversion-error';
+export { documentConversionErrorCodeLabels } from './document-conversion-error';

package/dist/models/v3/errors/document-conversion-error/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentConversionErrorCodeLabels = void 0;
+var document_conversion_error_1 = require("./document-conversion-error");
+Object.defineProperty(exports, "documentConversionErrorCodeLabels", { enumerable: true, get: function () { return document_conversion_error_1.documentConversionErrorCodeLabels; } });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/errors/document-conversion-error/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v3/errors/document-conversion-error/index.ts"],"names":[],"mappings":";;;AACA,yEAAgF;AAAvE,8IAAA,iCAAiC,OAAA"}

package/dist/models/v3/errors/fax-error/fax-error.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A problem occurred during the fax communication process.
+ */
+export interface FaxError {
+    /** Type of error for the fax */
+    errorType?: 'FAX_ERROR';
+    /** A developer-facing error message */
+    errorMessage?: string;
+    /** The error code returned describing the error of the call */
+    errorCode?: FaxErrorCodeEnum;
+}
+export type FaxErrorCodeEnum = 6 | 7 | 8 | 10 | 12 | 13 | 14 | 18 | 20 | 21 | 22 | 25 | 26 | 28 | 29 | 31 | 38 | 40 | 41 | 44 | 46 | 48 | 53 | 60 | 63 | 68 | 75 | 76 | 77 | 79 | 80 | 82 | 84 | 113 | 117 | 119 | 131 | 132 | 133 | number;
+export declare const faxErrorCodeLabels: Record<FaxErrorCodeEnum, string>;

package/dist/models/v3/errors/fax-error/fax-error.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.faxErrorCodeLabels = void 0;
+exports.faxErrorCodeLabels = {
+    6: 'There was an error communicating with the far side.',
+    7: 'Far end cannot receive at the size of image',
+    8: 'No response after sending a page',
+    10: 'Disconnected after permitted retries',
+    12: 'Received no response to DCS or TCF',
+    13: 'Timed out waiting for the first message',
+    14: 'Timed out waiting for initial communication',
+    18: 'Unexpected message received',
+    20: 'The HDLC carrier did not stop in a timely manner',
+    21: 'Received a DCN from remote after sending a page',
+    22: 'Received bad response to DCS or training',
+    25: 'Far end cannot receive at the resolution of the image',
+    26: 'The remote fax machine failed to respond',
+    28: 'Failed to train with any of the compatible modems',
+    29: 'Invalid response after sending a page',
+    31: 'Fax machine incompatibility',
+    38: 'The remote fax machine hung up before receiving fax',
+    40: 'Telephony error',
+    41: 'Unexpected DCN while waiting for DCS or DIS',
+    44: 'Telephony Error',
+    // eslint-disable-next-line max-len
+    46: 'Insufficient funds to send fax and not able to auto recharge; There was a problem charging your credit card. Please check your payment information and try again.',
+    48: 'No answer (The Receiving Machine May Be Out Of Paper)',
+    53: 'Unexpected DCN after EOM or MPS sequence',
+    60: 'Transmission error after page break',
+    63: 'Fax protocol error',
+    68: 'Far end is not compatible',
+    75: 'Manually canceled by user',
+    76: 'Canceled automatically because timeout exceeded',
+    77: 'Timed out waiting for receiver ready (ECM mode)',
+    79: 'Can\'t cancel the fax, it\'s already complete!',
+    80: 'Received a DCN while waiting for a DIS',
+    82: 'There was an error communicating with the far side',
+    84: 'Unexpected command after page received',
+    113: 'The file for this fax has been deleted or is not accessible.',
+    117: 'No pages received',
+    119: 'User requested simulated faxError',
+    131: 'Incomplete transmission',
+    132: 'No fax tone detected',
+    133: 'Phone number is not permitted',
+};
+//# sourceMappingURL=fax-error.js.map

package/dist/models/v3/errors/fax-error/fax-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fax-error.js","sourceRoot":"","sources":["../../../../../src/models/v3/errors/fax-error/fax-error.ts"],"names":[],"mappings":";;;AAiBa,QAAA,kBAAkB,GAAqC;IAClE,CAAC,EAAE,qDAAqD;IACxD,CAAC,EAAE,6CAA6C;IAChD,CAAC,EAAE,kCAAkC;IACrC,EAAE,EAAE,sCAAsC;IAC1C,EAAE,EAAE,oCAAoC;IACxC,EAAE,EAAE,yCAAyC;IAC7C,EAAE,EAAE,6CAA6C;IACjD,EAAE,EAAE,6BAA6B;IACjC,EAAE,EAAE,kDAAkD;IACtD,EAAE,EAAE,iDAAiD;IACrD,EAAE,EAAE,0CAA0C;IAC9C,EAAE,EAAE,uDAAuD;IAC3D,EAAE,EAAE,0CAA0C;IAC9C,EAAE,EAAE,mDAAmD;IACvD,EAAE,EAAE,uCAAuC;IAC3C,EAAE,EAAE,6BAA6B;IACjC,EAAE,EAAE,qDAAqD;IACzD,EAAE,EAAE,iBAAiB;IACrB,EAAE,EAAE,6CAA6C;IACjD,EAAE,EAAE,iBAAiB;IACrB,mCAAmC;IACnC,EAAE,EAAE,mKAAmK;IACvK,EAAE,EAAE,uDAAuD;IAC3D,EAAE,EAAE,0CAA0C;IAC9C,EAAE,EAAE,qCAAqC;IACzC,EAAE,EAAE,oBAAoB;IACxB,EAAE,EAAE,2BAA2B;IAC/B,EAAE,EAAE,2BAA2B;IAC/B,EAAE,EAAE,iDAAiD;IACrD,EAAE,EAAE,iDAAiD;IACrD,EAAE,EAAE,gDAAgD;IACpD,EAAE,EAAE,wCAAwC;IAC5C,EAAE,EAAE,oDAAoD;IACxD,EAAE,EAAE,wCAAwC;IAC5C,GAAG,EAAE,8DAA8D;IACnE,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,mCAAmC;IACxC,GAAG,EAAE,yBAAyB;IAC9B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,+BAA+B;CACrC,CAAC"}

package/dist/models/v3/errors/fax-error/index.d.ts

@@ -0,0 +1,2 @@
+export type { FaxError, FaxErrorCodeEnum } from './fax-error';
+export { faxErrorCodeLabels } from './fax-error';

package/dist/models/v3/errors/fax-error/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.faxErrorCodeLabels = void 0;
+var fax_error_1 = require("./fax-error");
+Object.defineProperty(exports, "faxErrorCodeLabels", { enumerable: true, get: function () { return fax_error_1.faxErrorCodeLabels; } });
+//# sourceMappingURL=index.js.map

package/dist/models/v3/errors/fax-error/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/v3/errors/fax-error/index.ts"],"names":[],"mappings":";;;AACA,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA"}

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

@@ -0,0 +1,3 @@
+export * from './call-error';
+export * from './document-conversion-error';
+export * from './fax-error';

package/dist/models/v3/errors/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("./call-error"), exports);
+__exportStar(require("./document-conversion-error"), exports);
+__exportStar(require("./fax-error"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v3/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,8DAA4C;AAC5C,8CAA4B"}

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

@@ -1,7 +1,7 @@
 import { BarCode } from '../bar-code';
 import { FaxContentUrl } from '../fax-content-url';
 import { FaxMoney } from '../fax-money';
-import { ErrorType, FaxDirection, FaxStatus, ImageConversionMethod, WebhookContentType } from '../enums';
+import { ErrorType, FaxDirection, FaxStatus, ImageConversionMethod, Resolution, WebhookContentType } from '../enums';
 export interface Fax {
     /** The id of a fax */
     id?: string;
@@ -19,12 +19,14 @@ export interface Fax {
     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. */
+    /** 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;
+    /** The number of pages successfully sent to the receiving side in the fax. */
+    pagesSentSuccessfully?: number;
     /** 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. */
@@ -41,22 +43,30 @@ export interface Fax {
     callbackUrl?: string;
     /** The content type of the callback. */
     callbackUrlContentType?: WebhookContentType;
-    /** Determines how documents are converted to black and white. Defaults to value selected on Fax Service object. */
+    /** Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. 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). */
+    /** One of the error numbers listed in the [Fax Error Messages section](https://developers.sinch.com/docs/fax/api-reference/fax/tag/Error-Messages/). */
     errorCode?: number;
-    /** One of the error messages listed in the [Fax Error Messages section](#FaxErrors). */
+    /** One of the error messages listed in the [Fax Error Messages section](https://developers.sinch.com/docs/fax/api-reference/fax/tag/Error-Messages/). */
     errorMessage?: 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;
+    /** @see Resolution */
+    resolution?: Resolution;
+    /** The cover page id you want to use for the fax */
+    coverPageId?: string;
+    /** You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this [here](https://developers.sinch.com/docs/fax/api-reference/fax/tag/Cover-pages/). All keys used must be lower case. */
+    coverPageData?: {
+        [key: string]: string;
+    };
+    /** The `Id` of the project associated with the call. */
+    projectId?: string;
+    /** ID of the fax service used. */
+    serviceId?: string;
 }

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

@@ -1,4 +1,4 @@
-import { ImageConversionMethod, WebhookContentType } from '../enums';
+import { ImageConversionMethod, Resolution, WebhookContentType } from '../enums';
 import { FaxContentUrl } from '../fax-content-url';
 import { FaxBase64File } from '../fax-base64-file';
 export type SingleFaxRequest = SingleFaxRequestJson | SingleFaxRequestFormData;
@@ -30,6 +30,14 @@ export interface FaxRequestBase {
     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;
+    /** @see Resolution */
+    resolution?: Resolution;
+    /** The cover page id you want to use for the fax */
+    coverPageId?: string;
+    /** You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this [here](https://developers.sinch.com/docs/fax/api-reference/fax/tag/Cover-pages/). All keys used must be lower case. */
+    coverPageData?: {
+        [key: string]: string;
+    };
 }
 export type FaxRequestJson = FaxRequestBase & {
     /** An array of base64 encoded files */

package/dist/models/v3/helper.js

@@ -3,9 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertToSupportedFileType = void 0;
 const enums_1 = require("./enums");
 const convertToSupportedFileType = (fileType) => {
-    if (!fileType || !enums_1.validBase64FileTypes.includes(fileType.toUpperCase())) {
+    if (!fileType) {
+        console.warn('No file extension has been defined.');
         return undefined;
     }
+    if (!enums_1.validBase64FileTypes.includes(fileType.toUpperCase())) {
+        console.warn(`The file extension "${fileType.toUpperCase()}" is not supported.`);
+    }
     return fileType.toUpperCase();
 };
 exports.convertToSupportedFileType = convertToSupportedFileType;

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

@@ -1 +1 @@
-{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v3/helper.ts"],"names":[],"mappings":";;;AAAA,mCAAkE;AAE3D,MAAM,0BAA0B,GAAG,CAAC,QAA4B,EAAiC,EAAE;IACxG,IAAI,CAAC,QAAQ,IAAI,CAAC,4BAAoB,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAuB,CAAC,EAAE,CAAC;QAC7F,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC,WAAW,EAAuB,CAAC;AACrD,CAAC,CAAC;AALW,QAAA,0BAA0B,8BAKrC"}
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v3/helper.ts"],"names":[],"mappings":";;;AAAA,mCAAkE;AAE3D,MAAM,0BAA0B,GAAG,CAAC,QAA4B,EAAiC,EAAE;IACxG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QACpD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,4BAAoB,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAuB,CAAC,EAAE,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,uBAAuB,QAAQ,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,QAAQ,CAAC,WAAW,EAAuB,CAAC;AACrD,CAAC,CAAC;AATW,QAAA,0BAA0B,8BASrC"}

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

@@ -1,15 +1,18 @@
 export * from './bar-code';
+export * from './cover-page';
+export * from './cover-page-file';
 export * from './date-range-filter';
 export * from './email';
+export * from './errors';
 export * from './fax';
 export * from './fax-base64-file';
 export * from './fax-content-url';
 export * from './fax-money';
 export * from './fax-request';
 export * from './faxes-list';
+export * from './number-with-permissions';
 export * from './mod-events';
 export * from './service';
-export * from './service-email-settings';
 export * from './service-phone-number';
 export * from './update-email-request';
 export * from './webhook-event-parsed';

package/dist/models/v3/index.js

@@ -15,17 +15,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./bar-code"), exports);
+__exportStar(require("./cover-page"), exports);
+__exportStar(require("./cover-page-file"), exports);
 __exportStar(require("./date-range-filter"), exports);
 __exportStar(require("./email"), exports);
+__exportStar(require("./errors"), exports);
 __exportStar(require("./fax"), exports);
 __exportStar(require("./fax-base64-file"), exports);
 __exportStar(require("./fax-content-url"), exports);
 __exportStar(require("./fax-money"), exports);
 __exportStar(require("./fax-request"), exports);
 __exportStar(require("./faxes-list"), exports);
+__exportStar(require("./number-with-permissions"), exports);
 __exportStar(require("./mod-events"), exports);
 __exportStar(require("./service"), exports);
-__exportStar(require("./service-email-settings"), exports);
 __exportStar(require("./service-phone-number"), exports);
 __exportStar(require("./update-email-request"), exports);
 __exportStar(require("./webhook-event-parsed"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,sDAAoC;AACpC,0CAAwB;AACxB,wCAAsB;AACtB,oDAAkC;AAClC,oDAAkC;AAClC,8CAA4B;AAC5B,gDAA8B;AAC9B,+CAA6B;AAC7B,+CAA6B;AAC7B,4CAA0B;AAC1B,2DAAyC;AACzC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,0CAAwB;AACxB,6CAA2B;AAC3B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,+CAA6B;AAC7B,oDAAkC;AAClC,sDAAoC;AACpC,0CAAwB;AACxB,2CAAyB;AACzB,wCAAsB;AACtB,oDAAkC;AAClC,oDAAkC;AAClC,8CAA4B;AAC5B,gDAA8B;AAC9B,+CAA6B;AAC7B,4DAA0C;AAC1C,+CAA6B;AAC7B,4CAA0B;AAC1B,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,0CAAwB;AACxB,6CAA2B;AAC3B,2CAAyB"}

package/dist/models/v3/number-with-permissions/index.d.ts

@@ -0,0 +1 @@
+export type { NumberWithPermissions } from './number-with-permissions';

package/dist/models/v3/number-with-permissions/index.js

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

package/dist/models/v3/number-with-permissions/index.js.map

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

package/dist/models/v3/number-with-permissions/number-with-permissions.d.ts

@@ -0,0 +1,10 @@
+import { Permissions } from '../enums';
+/**
+ * A phone number and its permissions.
+ */
+export interface NumberWithPermissions {
+    /** A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading \'+\'. */
+    number?: string;
+    /** Allows you to set permissions for sending and receiving faxes to this email/phone number combination. Default value is `both`. */
+    permissions?: Permissions;
+}

package/dist/models/v3/number-with-permissions/number-with-permissions.js

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

package/dist/models/v3/number-with-permissions/number-with-permissions.js.map

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

package/dist/models/v3/requests/cover-pages/cover-pages-request-data.d.ts

@@ -0,0 +1,27 @@
+import { CoverPageRequest } from '../../cover-page';
+export interface AddCoverPageRequestData {
+    /** the serviceId */
+    serviceId: string;
+    /**  */
+    addCoverPageRequestBody?: CoverPageRequest;
+}
+export interface DeleteCoverPageRequestData {
+    /** The serviceId containing the cover page you want to work with. */
+    serviceId: string;
+    /**  */
+    coverPageId: string;
+}
+export interface GetCoverPageRequestData {
+    /** The serviceId containing the cover page you want to work with. */
+    serviceId: string;
+    /**  */
+    coverPageId: string;
+}
+export interface ListCoverPagesRequestData {
+    /** the serviceId */
+    serviceId: string;
+    /** Number of cover pages to return on each request. */
+    pageSize?: number;
+    /** Optional. The page to fetch. If not specified, the first page will be returned. */
+    page?: string;
+}