stripe 22.3.0-alpha.4 → 22.3.0

package/cjs/resources/Identity/VerificationReports.d.ts

@@ -1,5 +1,4 @@
 import { StripeResource } from '../../StripeResource.js';
-import { BlocklistEntry } from './BlocklistEntries.js';
 import { PaginationParams, RangeQueryParam, Address } from '../../shared.js';
 import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
 export declare class VerificationReportResource extends StripeResource {
@@ -32,32 +31,32 @@ export interface VerificationReport {
     /**
      * Result from a document check
      */
-    document?: Identity.VerificationReport.Document;
+    document?: VerificationReport.Document;
     /**
      * Result from a email check
      */
-    email?: Identity.VerificationReport.Email;
+    email?: VerificationReport.Email;
     /**
      * Result from an id_number check
      */
-    id_number?: Identity.VerificationReport.IdNumber;
+    id_number?: VerificationReport.IdNumber;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
     livemode: boolean;
-    options?: Identity.VerificationReport.Options;
+    options?: VerificationReport.Options;
     /**
      * Result from a phone check
      */
-    phone?: Identity.VerificationReport.Phone;
+    phone?: VerificationReport.Phone;
     /**
      * Result from a selfie check
      */
-    selfie?: Identity.VerificationReport.Selfie;
+    selfie?: VerificationReport.Selfie;
     /**
      * Type of report.
      */
-    type: Identity.VerificationReport.Type;
+    type: VerificationReport.Type;
     /**
      * The configuration token of a verification flow from the dashboard.
      */
@@ -67,340 +66,312 @@ export interface VerificationReport {
      */
     verification_session: string | null;
 }
-export declare namespace Identity {
-    namespace VerificationReport {
-        interface Document {
-            /**
-             * Address as it appears in the document.
-             */
-            address: Address | null;
-            /**
-             * If document was not verified due to extracted data being on the blocklist, this is the token of the BlocklistEntry that blocked it
-             */
-            blocked_by_entry?: string | BlocklistEntry | null;
-            /**
-             * Date of birth as it appears in the document.
-             */
-            dob?: Document.Dob | null;
+export declare namespace VerificationReport {
+    interface Document {
+        /**
+         * Address as it appears in the document.
+         */
+        address: Address | null;
+        /**
+         * Date of birth as it appears in the document.
+         */
+        dob?: Document.Dob | null;
+        /**
+         * Details on the verification error. Present when status is `unverified`.
+         */
+        error: Document.Error | null;
+        /**
+         * Expiration date of the document.
+         */
+        expiration_date?: Document.ExpirationDate | null;
+        /**
+         * Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
+         */
+        files: Array<string> | null;
+        /**
+         * First name as it appears in the document.
+         */
+        first_name: string | null;
+        /**
+         * Issued date of the document.
+         */
+        issued_date: Document.IssuedDate | null;
+        /**
+         * Issuing country of the document.
+         */
+        issuing_country: string | null;
+        /**
+         * Last name as it appears in the document.
+         */
+        last_name: string | null;
+        /**
+         * Document ID number.
+         */
+        number?: string | null;
+        /**
+         * Sex of the person in the document.
+         */
+        sex?: Document.Sex | null;
+        /**
+         * Status of this `document` check.
+         */
+        status: Document.Status;
+        /**
+         * Type of the document.
+         */
+        type: Document.Type | null;
+        /**
+         * Place of birth as it appears in the document.
+         */
+        unparsed_place_of_birth?: string | null;
+        /**
+         * Sex as it appears in the document.
+         */
+        unparsed_sex?: string | null;
+    }
+    interface Email {
+        /**
+         * Email to be verified.
+         */
+        email: string | null;
+        /**
+         * Details on the verification error. Present when status is `unverified`.
+         */
+        error: Email.Error | null;
+        /**
+         * Status of this `email` check.
+         */
+        status: Email.Status;
+    }
+    interface IdNumber {
+        /**
+         * Date of birth.
+         */
+        dob?: IdNumber.Dob | null;
+        /**
+         * Details on the verification error. Present when status is `unverified`.
+         */
+        error: IdNumber.Error | null;
+        /**
+         * First name.
+         */
+        first_name: string | null;
+        /**
+         * ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.
+         */
+        id_number?: string | null;
+        /**
+         * Type of ID number.
+         */
+        id_number_type: IdNumber.IdNumberType | null;
+        /**
+         * Last name.
+         */
+        last_name: string | null;
+        /**
+         * Status of this `id_number` check.
+         */
+        status: IdNumber.Status;
+    }
+    interface Options {
+        document?: Options.Document;
+        id_number?: Options.IdNumber;
+    }
+    interface Phone {
+        /**
+         * Details on the verification error. Present when status is `unverified`.
+         */
+        error: Phone.Error | null;
+        /**
+         * Phone to be verified.
+         */
+        phone: string | null;
+        /**
+         * Status of this `phone` check.
+         */
+        status: Phone.Status;
+    }
+    interface Selfie {
+        /**
+         * ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
+         */
+        document: string | null;
+        /**
+         * Details on the verification error. Present when status is `unverified`.
+         */
+        error: Selfie.Error | null;
+        /**
+         * ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check.
+         */
+        selfie: string | null;
+        /**
+         * Status of this `selfie` check.
+         */
+        status: Selfie.Status;
+    }
+    type Type = 'document' | 'id_number' | 'verification_flow';
+    namespace Document {
+        interface Dob {
             /**
-             * Details on the verification error. Present when status is `unverified`.
+             * Numerical day between 1 and 31.
              */
-            error: Document.Error | null;
+            day: number | null;
             /**
-             * Expiration date of the document.
+             * Numerical month between 1 and 12.
              */
-            expiration_date?: Document.ExpirationDate | null;
+            month: number | null;
             /**
-             * Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
+             * The four-digit year.
              */
-            files: Array<string> | null;
+            year: number | null;
+        }
+        interface Error {
             /**
-             * First name as it appears in the document.
+             * A short machine-readable string giving the reason for the verification failure.
              */
-            first_name: string | null;
+            code: Error.Code | null;
             /**
-             * Issued date of the document.
+             * A human-readable message giving the reason for the failure. These messages can be shown to your users.
              */
-            issued_date: Document.IssuedDate | null;
+            reason: string | null;
+        }
+        interface ExpirationDate {
             /**
-             * Issuing country of the document.
+             * Numerical day between 1 and 31.
              */
-            issuing_country: string | null;
+            day: number | null;
             /**
-             * Last name as it appears in the document.
+             * Numerical month between 1 and 12.
              */
-            last_name: string | null;
+            month: number | null;
             /**
-             * Document ID number.
+             * The four-digit year.
              */
-            number?: string | null;
+            year: number | null;
+        }
+        interface IssuedDate {
             /**
-             * Sex of the person in the document.
+             * Numerical day between 1 and 31.
              */
-            sex?: Document.Sex | null;
+            day: number | null;
             /**
-             * Status of this `document` check.
+             * Numerical month between 1 and 12.
              */
-            status: Document.Status;
+            month: number | null;
             /**
-             * Type of the document.
+             * The four-digit year.
              */
-            type: Document.Type | null;
+            year: number | null;
+        }
+        type Sex = '[redacted]' | 'female' | 'male' | 'unknown';
+        type Status = 'unverified' | 'verified';
+        type Type = 'driving_license' | 'id_card' | 'passport';
+        namespace Error {
+            type Code = 'document_expired' | 'document_type_not_supported' | 'document_unverified_other';
+        }
+    }
+    namespace Email {
+        interface Error {
             /**
-             * Place of birth as it appears in the document.
+             * A short machine-readable string giving the reason for the verification failure.
              */
-            unparsed_place_of_birth?: string | null;
+            code: Error.Code | null;
             /**
-             * Sex as it appears in the document.
+             * A human-readable message giving the reason for the failure. These messages can be shown to your users.
              */
-            unparsed_sex?: string | null;
+            reason: string | null;
         }
-        interface Email {
-            /**
-             * Additional email verification details
-             */
-            details?: Email.Details;
+        type Status = 'unverified' | 'verified';
+        namespace Error {
+            type Code = 'email_unverified_other' | 'email_verification_declined';
+        }
+    }
+    namespace IdNumber {
+        interface Dob {
             /**
-             * Email to be verified.
+             * Numerical day between 1 and 31.
              */
-            email: string | null;
+            day: number | null;
             /**
-             * Details on the verification error. Present when status is `unverified`.
+             * Numerical month between 1 and 12.
              */
-            error: Email.Error | null;
+            month: number | null;
             /**
-             * Status of this `email` check.
+             * The four-digit year.
              */
-            status: Email.Status;
+            year: number | null;
         }
-        interface IdNumber {
-            /**
-             * Date of birth.
-             */
-            dob?: IdNumber.Dob | null;
+        interface Error {
             /**
-             * Details on the verification error. Present when status is `unverified`.
+             * A short machine-readable string giving the reason for the verification failure.
              */
-            error: IdNumber.Error | null;
+            code: Error.Code | null;
             /**
-             * First name.
+             * A human-readable message giving the reason for the failure. These messages can be shown to your users.
              */
-            first_name: string | null;
+            reason: string | null;
+        }
+        type IdNumberType = 'br_cpf' | 'sg_nric' | 'us_ssn';
+        type Status = 'unverified' | 'verified';
+        namespace Error {
+            type Code = 'id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other';
+        }
+    }
+    namespace Options {
+        interface Document {
             /**
-             * ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.
+             * Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
              */
-            id_number?: string | null;
+            allowed_types?: Array<Document.AllowedType>;
             /**
-             * Type of ID number.
+             * Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
              */
-            id_number_type: IdNumber.IdNumberType | null;
+            require_id_number?: boolean;
             /**
-             * Last name.
+             * Disable image uploads, identity document images have to be captured using the device's camera.
              */
-            last_name: string | null;
+            require_live_capture?: boolean;
             /**
-             * Status of this `id_number` check.
+             * Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
              */
-            status: IdNumber.Status;
+            require_matching_selfie?: boolean;
         }
-        interface Options {
-            document?: Options.Document;
-            id_number?: Options.IdNumber;
+        interface IdNumber {
         }
-        interface Phone {
-            /**
-             * Details on the verification error. Present when status is `unverified`.
-             */
-            error: Phone.Error | null;
-            /**
-             * Phone to be verified.
-             */
-            phone: string | null;
-            /**
-             * Status of this `phone` check.
-             */
-            status: Phone.Status;
+        namespace Document {
+            type AllowedType = 'driving_license' | 'id_card' | 'passport';
         }
-        interface Selfie {
-            /**
-             * If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
-             */
-            blocked_by_entry?: string | BlocklistEntry | null;
+    }
+    namespace Phone {
+        interface Error {
             /**
-             * ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
+             * A short machine-readable string giving the reason for the verification failure.
              */
-            document: string | null;
+            code: Error.Code | null;
             /**
-             * Details on the verification error. Present when status is `unverified`.
+             * A human-readable message giving the reason for the failure. These messages can be shown to your users.
              */
-            error: Selfie.Error | null;
+            reason: string | null;
+        }
+        type Status = 'unverified' | 'verified';
+        namespace Error {
+            type Code = 'phone_unverified_other' | 'phone_verification_declined';
+        }
+    }
+    namespace Selfie {
+        interface Error {
             /**
-             * ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check.
+             * A short machine-readable string giving the reason for the verification failure.
              */
-            selfie: string | null;
+            code: Error.Code | null;
             /**
-             * Status of this `selfie` check.
+             * A human-readable message giving the reason for the failure. These messages can be shown to your users.
              */
-            status: Selfie.Status;
-        }
-        type Type = 'document' | 'email' | 'id_number' | 'verification_flow';
-        namespace Document {
-            interface Dob {
-                /**
-                 * Numerical day between 1 and 31.
-                 */
-                day: number | null;
-                /**
-                 * Numerical month between 1 and 12.
-                 */
-                month: number | null;
-                /**
-                 * The four-digit year.
-                 */
-                year: number | null;
-            }
-            interface Error {
-                /**
-                 * A short machine-readable string giving the reason for the verification failure.
-                 */
-                code: Error.Code | null;
-                /**
-                 * A human-readable message giving the reason for the failure. These messages can be shown to your users.
-                 */
-                reason: string | null;
-            }
-            interface ExpirationDate {
-                /**
-                 * Numerical day between 1 and 31.
-                 */
-                day: number | null;
-                /**
-                 * Numerical month between 1 and 12.
-                 */
-                month: number | null;
-                /**
-                 * The four-digit year.
-                 */
-                year: number | null;
-            }
-            interface IssuedDate {
-                /**
-                 * Numerical day between 1 and 31.
-                 */
-                day: number | null;
-                /**
-                 * Numerical month between 1 and 12.
-                 */
-                month: number | null;
-                /**
-                 * The four-digit year.
-                 */
-                year: number | null;
-            }
-            type Sex = '[redacted]' | 'female' | 'male' | 'unknown';
-            type Status = 'unverified' | 'verified';
-            type Type = 'driving_license' | 'id_card' | 'passport';
-            namespace Error {
-                type Code = 'document_expired' | 'document_type_not_supported' | 'document_unverified_other';
-            }
-        }
-        namespace Email {
-            interface Details {
-                /**
-                 * Number of days from the time when the email domain was first observed to the time of verification.
-                 */
-                days_since_domain_creation?: number;
-                /**
-                 * Number of days from the time when the email address was first observed to the time of verification.
-                 */
-                days_since_ownership_started?: number;
-                /**
-                 * Two-letter ISO 3166-1 alpha-2 country code of the email domain's country.
-                 */
-                domain_country?: string;
-            }
-            interface Error {
-                /**
-                 * A short machine-readable string giving the reason for the verification failure.
-                 */
-                code: Error.Code | null;
-                /**
-                 * A human-readable message giving the reason for the failure. These messages can be shown to your users.
-                 */
-                reason: string | null;
-            }
-            type Status = 'unverified' | 'verified';
-            namespace Error {
-                type Code = 'email_unverified_other' | 'email_verification_declined';
-            }
-        }
-        namespace IdNumber {
-            interface Dob {
-                /**
-                 * Numerical day between 1 and 31.
-                 */
-                day: number | null;
-                /**
-                 * Numerical month between 1 and 12.
-                 */
-                month: number | null;
-                /**
-                 * The four-digit year.
-                 */
-                year: number | null;
-            }
-            interface Error {
-                /**
-                 * A short machine-readable string giving the reason for the verification failure.
-                 */
-                code: Error.Code | null;
-                /**
-                 * A human-readable message giving the reason for the failure. These messages can be shown to your users.
-                 */
-                reason: string | null;
-            }
-            type IdNumberType = 'br_cpf' | 'sg_nric' | 'us_ssn';
-            type Status = 'unverified' | 'verified';
-            namespace Error {
-                type Code = 'id_number_insufficient_document_data' | 'id_number_mismatch' | 'id_number_unverified_other';
-            }
-        }
-        namespace Options {
-            interface Document {
-                /**
-                 * Array of strings of allowed identity document types. If the provided identity document isn't one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
-                 */
-                allowed_types?: Array<Document.AllowedType>;
-                /**
-                 * Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
-                 */
-                require_id_number?: boolean;
-                /**
-                 * Disable image uploads, identity document images have to be captured using the device's camera.
-                 */
-                require_live_capture?: boolean;
-                /**
-                 * Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
-                 */
-                require_matching_selfie?: boolean;
-            }
-            interface IdNumber {
-            }
-            namespace Document {
-                type AllowedType = 'driving_license' | 'id_card' | 'passport';
-            }
+            reason: string | null;
         }
-        namespace Phone {
-            interface Error {
-                /**
-                 * A short machine-readable string giving the reason for the verification failure.
-                 */
-                code: Error.Code | null;
-                /**
-                 * A human-readable message giving the reason for the failure. These messages can be shown to your users.
-                 */
-                reason: string | null;
-            }
-            type Status = 'unverified' | 'verified';
-            namespace Error {
-                type Code = 'phone_unverified_other' | 'phone_verification_declined';
-            }
-        }
-        namespace Selfie {
-            interface Error {
-                /**
-                 * A short machine-readable string giving the reason for the verification failure.
-                 */
-                code: Error.Code | null;
-                /**
-                 * A human-readable message giving the reason for the failure. These messages can be shown to your users.
-                 */
-                reason: string | null;
-            }
-            type Status = 'unverified' | 'verified';
-            namespace Error {
-                type Code = 'selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other';
-            }
+        type Status = 'unverified' | 'verified';
+        namespace Error {
+            type Code = 'selfie_document_missing_photo' | 'selfie_face_mismatch' | 'selfie_manipulated' | 'selfie_unverified_other';
         }
     }
 }
@@ -414,10 +385,6 @@ export declare namespace Identity {
 }
 export declare namespace Identity {
     interface VerificationReportListParams extends PaginationParams {
-        /**
-         * Only return VerificationReports that were blocked by this BlocklistEntry id.
-         */
-        blocked_by_entry?: string;
         /**
          * A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
          */
@@ -440,6 +407,6 @@ export declare namespace Identity {
         verification_session?: string;
     }
     namespace VerificationReportListParams {
-        type Type = 'document' | 'email' | 'id_number';
+        type Type = 'document' | 'id_number';
     }
 }

package/cjs/resources/Identity/VerificationReports.js.map

@@ -1 +1 @@
-{"version":3,"file":"VerificationReports.js","sourceRoot":"","sources":["../../../src/resources/Identity/VerificationReports.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAKvD,MAAa,0BAA2B,SAAQ,kCAAc;IAC5D;;OAEG;IACH,IAAI,CACF,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,EACnC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjCD,gEAiCC"}
+{"version":3,"file":"VerificationReports.js","sourceRoot":"","sources":["../../../src/resources/Identity/VerificationReports.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAIvD,MAAa,0BAA2B,SAAQ,kCAAc;IAC5D;;OAEG;IACH,IAAI,CACF,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,EACnC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjCD,gEAiCC"}