@frankieone/one-sdk 0.0.2-npm → 0.0.3-npm

package/dist/esm/modules/common/shared/models/internal/models/Document_Attachment.d.ts

@@ -0,0 +1,108 @@
+import type { Data_URI_Base64 } from './Data_URI_Base64';
+export type Document_Attachment = {
+    /**
+     * When a document attachment is created/uploaded, it is assigned an attachmentId. You'll see this in a successful response or successfully accepted response. This can then be referenced in subsequent calls if you're uploading more/updated data.
+     */
+    attachmentId?: string;
+    /**
+     * The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map.
+     */
+    sourceId?: string;
+    /**
+     * The date and time the attachment was created. Not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment.
+     */
+    createdAt?: string;
+    /**
+     * If you're uploading a file where it's important to keep the original filename, then you can provide that here. Otherwise the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type
+     */
+    filename: string;
+    /**
+     * The standard MIME type of the file being uploaded. We'll double-check to be certain, but this can help speed things up
+     */
+    mimeType: string;
+    /**
+     * If uploading multiple pages - it's handy to keep a track of these. There is no enforcement of these numbers at all. You can have 10 page 1's and a page 29 if you wish.
+     */
+    pageNumber?: number;
+    /**
+     * Describes if an attachment is of the Front or Back of an attachment. If not supplied, Front is always assumed.
+     */
+    side?: Document_Attachment.side;
+    /**
+     * Valid document attachment general types.
+     *
+     * - "PHOTO": Any photo
+     * - "VIDEO": Any video
+     * - "AUDIO": Any audio
+     * - "PDF": PDF or PS (may contain text, images or both)
+     * - "DOC": Word doc, RTF, etc
+     * - "ZIP": Any compressed file(s)
+     */
+    type?: string;
+    /**
+     * Reference to where the data can be retrieved from.
+     */
+    location?: string;
+    data: Data_URI_Base64;
+    lastMalwareScanAt?: string;
+    /**
+     * The reason why the data in a response is missing.
+     *
+     *
+     * - "NORMAL": The data was retrieved and is included. If it is empty then
+     * it was never provided or was provided empty.
+     *
+     * - "EXCLUDED": The retrieval request was not for 'full' data, or the object
+     * has been deleted so the data is not included
+     *
+     * - "FAILED": The data could not be retrieved from the secure document
+     * store.
+     *
+     * The enum retrievalStatus will not usually be set in a request. If a
+     * attachment in a response has a 'FAILED' retrieval state then
+     * that object should not be sent back in a future possible update. It should
+     * either be omitted or the original data should be resent if it is available
+     * from another source. However it is safe to send the object in an update
+     * with the state received in a response. Any state other than 'NORMAL' (or
+     * '') will cause the blank data to be ignored, but other fields in the
+     * object will be updated if needed.
+     */
+    retrievalStatus?: Document_Attachment.retrievalStatus;
+};
+export declare namespace Document_Attachment {
+    /**
+     * Describes if an attachment is of the Front or Back of an attachment. If not supplied, Front is always assumed.
+     */
+    enum side {
+        FRONT = "FRONT",
+        BACK = "BACK"
+    }
+    /**
+     * The reason why the data in a response is missing.
+     *
+     *
+     * - "NORMAL": The data was retrieved and is included. If it is empty then
+     * it was never provided or was provided empty.
+     *
+     * - "EXCLUDED": The retrieval request was not for 'full' data, or the object
+     * has been deleted so the data is not included
+     *
+     * - "FAILED": The data could not be retrieved from the secure document
+     * store.
+     *
+     * The enum retrievalStatus will not usually be set in a request. If a
+     * attachment in a response has a 'FAILED' retrieval state then
+     * that object should not be sent back in a future possible update. It should
+     * either be omitted or the original data should be resent if it is available
+     * from another source. However it is safe to send the object in an update
+     * with the state received in a response. Any state other than 'NORMAL' (or
+     * '') will cause the blank data to be ignored, but other fields in the
+     * object will be updated if needed.
+     */
+    enum retrievalStatus {
+        NORMAL = "NORMAL",
+        EXCLUDED = "EXCLUDED",
+        FAILED = "FAILED"
+    }
+}
+//# sourceMappingURL=Document_Attachment.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Attachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Attachment.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Attachment.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAChC;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,eAAe,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC;CACvD,CAAC;AAEF,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,KAAY,IAAI;QACd,KAAK,UAAU;QACf,IAAI,SAAS;KACd;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAY,eAAe;QACzB,MAAM,WAAW;QACjB,QAAQ,aAAa;QACrB,MAAM,WAAW;KAClB;CACF"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Attachment.js

@@ -0,0 +1,43 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export var Document_Attachment;
+(function (Document_Attachment) {
+    /**
+     * Describes if an attachment is of the Front or Back of an attachment. If not supplied, Front is always assumed.
+     */
+    let side;
+    (function (side) {
+        side["FRONT"] = "FRONT";
+        side["BACK"] = "BACK";
+    })(side = Document_Attachment.side || (Document_Attachment.side = {}));
+    /**
+     * The reason why the data in a response is missing.
+     *
+     *
+     * - "NORMAL": The data was retrieved and is included. If it is empty then
+     * it was never provided or was provided empty.
+     *
+     * - "EXCLUDED": The retrieval request was not for 'full' data, or the object
+     * has been deleted so the data is not included
+     *
+     * - "FAILED": The data could not be retrieved from the secure document
+     * store.
+     *
+     * The enum retrievalStatus will not usually be set in a request. If a
+     * attachment in a response has a 'FAILED' retrieval state then
+     * that object should not be sent back in a future possible update. It should
+     * either be omitted or the original data should be resent if it is available
+     * from another source. However it is safe to send the object in an update
+     * with the state received in a response. Any state other than 'NORMAL' (or
+     * '') will cause the blank data to be ignored, but other fields in the
+     * object will be updated if needed.
+     */
+    let retrievalStatus;
+    (function (retrievalStatus) {
+        retrievalStatus["NORMAL"] = "NORMAL";
+        retrievalStatus["EXCLUDED"] = "EXCLUDED";
+        retrievalStatus["FAILED"] = "FAILED";
+    })(retrievalStatus = Document_Attachment.retrievalStatus || (Document_Attachment.retrievalStatus = {}));
+})(Document_Attachment || (Document_Attachment = {}));
+//# sourceMappingURL=Document_Attachment.js.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Attachment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Attachment.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Attachment.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AA2EpB,MAAM,KAAW,mBAAmB,CAoCnC;AApCD,WAAiB,mBAAmB;IAClC;;OAEG;IACH,IAAY,IAGX;IAHD,WAAY,IAAI;QACd,uBAAe,CAAA;QACf,qBAAa,CAAA;IACf,CAAC,EAHW,IAAI,GAAJ,wBAAI,KAAJ,wBAAI,QAGf;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAY,eAIX;IAJD,WAAY,eAAe;QACzB,oCAAiB,CAAA;QACjB,wCAAqB,CAAA;QACrB,oCAAiB,CAAA;IACnB,CAAC,EAJW,eAAe,GAAf,mCAAe,KAAf,mCAAe,QAI1B;AACH,CAAC,EApCgB,mBAAmB,KAAnB,mBAAmB,QAoCnC"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Class.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The classification of document that identifies how it should be used or interpreted.
+ */
+export declare enum Document_Class {
+    OTHER = "OTHER",
+    IDENTITY = "IDENTITY",
+    SUPPORTING = "SUPPORTING",
+    REPORT = "REPORT"
+}
+//# sourceMappingURL=Document_Class.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Class.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Class.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Class.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,oBAAY,cAAc;IACxB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,MAAM,WAAW;CAClB"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Class.js

@@ -0,0 +1,14 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The classification of document that identifies how it should be used or interpreted.
+ */
+export var Document_Class;
+(function (Document_Class) {
+    Document_Class["OTHER"] = "OTHER";
+    Document_Class["IDENTITY"] = "IDENTITY";
+    Document_Class["SUPPORTING"] = "SUPPORTING";
+    Document_Class["REPORT"] = "REPORT";
+})(Document_Class || (Document_Class = {}));
+//# sourceMappingURL=Document_Class.js.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Class.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Class.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AAEpB;;GAEG;AACH,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,uCAAqB,CAAA;IACrB,2CAAyB,CAAA;IACzB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB"}

package/dist/esm/modules/common/shared/models/internal/models/Document_ID.d.ts

@@ -0,0 +1,6 @@
+/**
+ * As documents are added to an entity, they're assigned a unique identifier to assist with modification and reference.
+ * To modify a document, include the documentId in an update request call.
+ */
+export type Document_ID = string;
+//# sourceMappingURL=Document_ID.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Document_ID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_ID.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_ID.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Document_ID.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Document_ID.js.map

package/dist/esm/modules/common/shared/models/internal/models/Document_ID.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_ID.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_ID.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Information.d.ts

@@ -0,0 +1,130 @@
+import type { Custom_Attributes } from './Custom_Attributes';
+import type { Date } from './Date';
+import type { Document_Attachment } from './Document_Attachment';
+import type { Document_Class } from './Document_Class';
+import type { Document_ID } from './Document_ID';
+import type { Document_Supplementary_Data } from './Document_Supplementary_Data';
+import type { Entity_ID } from './Entity_ID';
+export type Document_Information = {
+    documentId?: Document_ID;
+    entityId?: Entity_ID;
+    /**
+     * The expiry date of the document in YYYY-MM-DD format
+     */
+    expiryDate?: Date;
+    /**
+     * The issued date of the document in YYYY-MM-DD format
+     */
+    issueDate?: Date;
+    /**
+     * The primary ID number of the document e.g the ID number on a driver licence
+     */
+    primaryIdentifier?: string;
+    /**
+     * The secondary ID number of the document e.g the card number on a driver licence
+     */
+    secondaryIdentifier?: string;
+    /**
+     * Valid ID types
+     *
+     * - "OTHER": Generic document type. Unspecified.
+     * - "DRIVERS_LICENCE": Driver's licence.
+     * - "PASSPORT": Passport
+     * - "VISA": Visa document (not Visa payment card)
+     * - "IMMIGRATION": Immigration card
+     * - "NATIONAL_ID": Any national ID card
+     * - "TAX_ID": Any national tax identifier
+     * - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g. Medicare, NHS)
+     * - "CONCESSION": State issued concession card
+     * - "HEALTH_CONCESSION": State issued health specific concession card
+     * - "PENSION": State issued pension ID
+     * - "MILITARY_ID": Military ID
+     * - "BIRTH_CERT": Birth certificate
+     * - "CITIZENSHIP": Citizenship certificate
+     * - "MARRIAGE_CERT": Marriage certificate
+     * - "DEATH_CERT": Death certificate
+     * - "NAME_CHANGE": Name change confirmation
+     * - "UTILITY_BILL": Regulated utility bill, such as electricity, gas, etc
+     * - "BANK_STATEMENT": Bank/card statement
+     * - "BANK_ACCOUNT": Bank account
+     * - "INTENT_PROOF": A proof of intent. Generally a photo/video, or a scanned letter
+     * - "ATTESTATION": A document of attestation (e.g. Statutory Declaration).
+     *
+     * NOTE: these cannot be used as a supporting document
+     * - "SELF_IMAGE": A "selfie" used for comparisons
+     * - "EMAIL_ADDRESS": An email address
+     * - "MSISDN": A mobile phone number
+     * - "DEVICE": A device ID
+     * - "VEHICLE_REGISTRATION": Vehicle registration number
+     * - "PROOF_OF_ADDRESS": Can be any type of document that provides a proof of address
+     * - "HOUSE_REGISTRATION": House registration document
+     * - "YELLOW_HOUSE_REGISTRATION": Yellow House Registration Thor Ror 13
+     * - "WORK_PERMIT": Work permit
+     * - "EMPLOYMENT_CERTIFICATE": Certificate of employment
+     * - "NOTARY_PUBLIC_ID": Notary Public Identification
+     *
+     * Business related documentation
+     *
+     * - "EXTERNAL_ADMIN": Details of appointed administrator.
+     * - "CHARGES": Details of any charges that have been laid against a company or director
+     * - "PRE_ASIC": Any documents that are Pre-ASIC
+     * - "ANNUAL_RETURN": Details of a company's annual return
+     * - "REPORT": Frankie generated report.
+     * - "TRUST_DEED": Corporate trust deed
+     * - "PARTNERSHIP_AGREEMENT": Partnership agreement documents
+     * - "ADMIN_CHANGE": Change of Administrator
+     * - "COMPANY_REPORT": Registry filed company reports
+     *
+     * Special document types
+     *
+     * - "CHECK_RESULTS": A special document type for specifying results of checks completed other than through Frankie.
+     */
+    type?: string;
+    /**
+     * The sub-type of the document, if relevant. This can include specific report or attestation types e.g. FACIAL_COMPARISON (attestation) or KYC (report)
+     */
+    subtype?: string;
+    /**
+     * The abbreviated ISO3166 subdivision/region where the ID was distributed e.g. "VIC" for The Australian state of Victoria or "MA" for the US state of Massachusetts
+     */
+    subdivision?: string;
+    /**
+     * The ISO3166 alpha3 country code where the document was issued, if relevant.
+     * For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
+     */
+    country?: string;
+    class?: Document_Class;
+    /**
+     * The date when the document requested
+     */
+    readonly requestedAt?: string;
+    /**
+     * The date when the document was created in YYYY-MM-DD format
+     */
+    readonly createdAt?: string;
+    /**
+     * The date when the document was updated in YYYY-MM-DD format
+     */
+    readonly updatedAt?: string;
+    /**
+     * when did the validity period begin for this document, if applicable
+     */
+    validFrom?: Date;
+    /**
+     * when did the validity period end for this document, if applicable
+     */
+    validTo?: Date;
+    /**
+     * The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map.
+     */
+    readonly sourceId?: string;
+    supplementaryData?: Document_Supplementary_Data;
+    customAttributes?: Custom_Attributes;
+    /**
+     * List of scans, pages or files for a single document e.g. front and back images of a driver licence, or page 1, 2 and 3 of a supporting document.
+     *
+     * Attachments can be uploaded in a single call, or in multiple calls. To upload attachments over multiple calls, include the documentId in the request.
+     */
+    attachments?: Array<Document_Attachment>;
+};
+//# sourceMappingURL=Document_Information.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Information.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Information.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Information.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,2BAA2B,CAAC;IAChD,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CAC1C,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Information.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Document_Information.js.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Information.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Information.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Information.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Supplementary_Data.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Supplementary information related to a document or report e.g. OCR extraction data, facial comparison report breakdowns
+ */
+export type Document_Supplementary_Data = {
+    data?: string;
+};
+//# sourceMappingURL=Document_Supplementary_Data.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Supplementary_Data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Supplementary_Data.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Supplementary_Data.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Document_Supplementary_Data.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Document_Supplementary_Data.js.map

package/dist/esm/modules/common/shared/models/internal/models/Document_Supplementary_Data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document_Supplementary_Data.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Document_Supplementary_Data.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Email.d.ts

@@ -0,0 +1,44 @@
+export type Email = {
+    /**
+     * As emails are added to an entity, they're assigned a unique identifier to assist with modification and reference.
+     * To modify an email, include the emailId in an update request call.
+     */
+    readonly emailId?: string;
+    /**
+     * Used to capture the type of email address, if known.
+     */
+    type?: Email.type;
+    /**
+     * The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map.
+     */
+    readonly sourceId?: string;
+    /**
+     * The individuals email address. This email can be used to notify the individual of any verification requirements
+     */
+    email?: string;
+    /**
+     * Indicates whether this email address is the individuals preferred email. The preferred email will be used to send notifications on the clients request
+     */
+    isPreferred?: boolean;
+    /**
+     * If the email is attached to (an) address(es), the address ids of that address would be present
+     */
+    readonly linkedAddresses?: Array<{
+        /**
+         * This is the addressId of the linked address
+         */
+        addressId?: string;
+    }>;
+};
+export declare namespace Email {
+    /**
+     * Used to capture the type of email address, if known.
+     */
+    enum type {
+        OTHER = "OTHER",
+        WORK = "WORK",
+        PERSONAL = "PERSONAL",
+        BUSINESS = "BUSINESS"
+    }
+}
+//# sourceMappingURL=Email.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Email.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Email.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC;QAC/B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;CACJ,CAAC;AAEF,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACH,KAAY,IAAI;QACd,KAAK,UAAU;QACf,IAAI,SAAS;QACb,QAAQ,aAAa;QACrB,QAAQ,aAAa;KACtB;CACF"}

package/dist/esm/modules/common/shared/models/internal/models/Email.js

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export var Email;
+(function (Email) {
+    /**
+     * Used to capture the type of email address, if known.
+     */
+    let type;
+    (function (type) {
+        type["OTHER"] = "OTHER";
+        type["WORK"] = "WORK";
+        type["PERSONAL"] = "PERSONAL";
+        type["BUSINESS"] = "BUSINESS";
+    })(type = Email.type || (Email.type = {}));
+})(Email || (Email = {}));
+//# sourceMappingURL=Email.js.map

package/dist/esm/modules/common/shared/models/internal/models/Email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Email.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Email.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AAmCpB,MAAM,KAAW,KAAK,CAUrB;AAVD,WAAiB,KAAK;IACpB;;OAEG;IACH,IAAY,IAKX;IALD,WAAY,IAAI;QACd,uBAAe,CAAA;QACf,qBAAa,CAAA;QACb,6BAAqB,CAAA;QACrB,6BAAqB,CAAA;IACvB,CAAC,EALW,IAAI,GAAJ,UAAI,KAAJ,UAAI,QAKf;AACH,CAAC,EAVgB,KAAK,KAAL,KAAK,QAUrB"}

package/dist/esm/modules/common/shared/models/internal/models/Entity.d.ts

@@ -0,0 +1,40 @@
+import type { Address } from './Address';
+import type { Custom_Attributes } from './Custom_Attributes';
+import type { Email } from './Email';
+import type { Entity_Documents } from './Entity_Documents';
+import type { Entity_ID } from './Entity_ID';
+import type { Entity_Type } from './Entity_Type';
+import type { External_Reference } from './External_Reference';
+import type { Phone_Number } from './Phone_Number';
+export type Entity = {
+    entityId?: Entity_ID;
+    entityType?: Entity_Type;
+    readonly createdAt?: string;
+    /**
+     * Schema version of this entity
+     */
+    readonly schemaVersion?: number;
+    /**
+     * A list containing all address information associated with the entity
+     */
+    addresses?: Array<Address>;
+    /**
+     * A list containing all phone numbers associated with the entity
+     */
+    phoneNumbers?: Array<Phone_Number>;
+    /**
+     * A list containing all email addresses associated with the entity
+     */
+    emailAddresses?: Array<Email>;
+    customAttributes?: Custom_Attributes;
+    /**
+     * A list containing all external references associated with the entity
+     */
+    externalReferences?: Array<External_Reference>;
+    documents?: Entity_Documents;
+    /**
+     * The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map.
+     */
+    readonly sourceId?: string;
+};
+//# sourceMappingURL=Entity.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9B,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IACrC;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC/C,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Entity.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Entity.js.map

package/dist/esm/modules/common/shared/models/internal/models/Entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Entity_Documents.d.ts

@@ -0,0 +1,8 @@
+import type { Document_Information } from './Document_Information';
+export type Entity_Documents = {
+    REPORT?: Array<Document_Information>;
+    SUPPORTING?: Array<Document_Information>;
+    IDENTITY?: Array<Document_Information>;
+    OTHER?: Array<Document_Information>;
+};
+//# sourceMappingURL=Entity_Documents.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Entity_Documents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity_Documents.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity_Documents.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACrC,UAAU,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACrC,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Entity_Documents.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Entity_Documents.js.map

package/dist/esm/modules/common/shared/models/internal/models/Entity_Documents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity_Documents.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity_Documents.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Entity_ID.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Entity's are assigned an auto-generated UUID to ensure global uniqueness, represented as an entityId. The entityId allows for precise modification when required.
+ * To modify an entity, set the entityId of the entity you wish to update in an update request call.
+ */
+export type Entity_ID = string;
+//# sourceMappingURL=Entity_ID.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Entity_ID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity_ID.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity_ID.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Entity_ID.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Entity_ID.js.map

package/dist/esm/modules/common/shared/models/internal/models/Entity_ID.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity_ID.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity_ID.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Entity_Type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Type of entity within Frankie. This can either be "INDIVIDUAL", "ORGANIZATION" or "UNKNOWN"
+ */
+export declare enum Entity_Type {
+    INDIVIDUAL = "INDIVIDUAL",
+    ORGANIZATION = "ORGANIZATION",
+    UNKNOWN = "UNKNOWN"
+}
+//# sourceMappingURL=Entity_Type.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Entity_Type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity_Type.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity_Type.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,oBAAY,WAAW;IACrB,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,OAAO,YAAY;CACpB"}

package/dist/esm/modules/common/shared/models/internal/models/Entity_Type.js

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Type of entity within Frankie. This can either be "INDIVIDUAL", "ORGANIZATION" or "UNKNOWN"
+ */
+export var Entity_Type;
+(function (Entity_Type) {
+    Entity_Type["INDIVIDUAL"] = "INDIVIDUAL";
+    Entity_Type["ORGANIZATION"] = "ORGANIZATION";
+    Entity_Type["UNKNOWN"] = "UNKNOWN";
+})(Entity_Type || (Entity_Type = {}));
+//# sourceMappingURL=Entity_Type.js.map

package/dist/esm/modules/common/shared/models/internal/models/Entity_Type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity_Type.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Entity_Type.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AAEpB;;GAEG;AACH,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,wCAAyB,CAAA;IACzB,4CAA6B,CAAA;IAC7B,kCAAmB,CAAA;AACrB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB"}

package/dist/esm/modules/common/shared/models/internal/models/Error.d.ts

@@ -0,0 +1,6 @@
+import type { Error_Base } from './Error_Base';
+import type { Request_ID } from './Request_ID';
+export type Error = Error_Base & {
+    requestId?: Request_ID;
+};
+//# sourceMappingURL=Error.d.ts.map

package/dist/esm/modules/common/shared/models/internal/models/Error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Error.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG;IAC/B,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB,CAAC"}

package/dist/esm/modules/common/shared/models/internal/models/Error.js

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};
+//# sourceMappingURL=Error.js.map

package/dist/esm/modules/common/shared/models/internal/models/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../../../../../../modules/common/shared/models/internal/models/Error.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB"}

package/dist/esm/modules/common/shared/models/internal/models/Error_Base.d.ts

@@ -0,0 +1,7 @@
+import type { Issue } from './Issue';
+export type Error_Base = {
+    errorCode?: string;
+    errorMsg?: string;
+    details?: Array<Issue>;
+};
+//# sourceMappingURL=Error_Base.d.ts.map