@depup/stripe 21.0.0-depup.0

package/types/Identity/VerificationSessionsResource.d.ts

@@ -0,0 +1,366 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Identity {
+      interface VerificationSessionCreateParams {
+        /**
+         * 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.
+         */
+        client_reference_id?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * A set of options for the session's verification checks.
+         */
+        options?: VerificationSessionCreateParams.Options;
+
+        /**
+         * Details provided about the user being verified. These details may be shown to the user.
+         */
+        provided_details?: VerificationSessionCreateParams.ProvidedDetails;
+
+        /**
+         * Customer ID
+         */
+        related_customer?: string;
+
+        /**
+         * The ID of the Account representing a customer.
+         */
+        related_customer_account?: string;
+
+        /**
+         * Tokens referencing a Person resource and it's associated account.
+         */
+        related_person?: VerificationSessionCreateParams.RelatedPerson;
+
+        /**
+         * The URL that the user will be redirected to upon completing the verification flow.
+         */
+        return_url?: string;
+
+        /**
+         * The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
+         */
+        type?: VerificationSessionCreateParams.Type;
+
+        /**
+         * The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
+         */
+        verification_flow?: string;
+      }
+
+      namespace VerificationSessionCreateParams {
+        interface Options {
+          /**
+           * Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
+           */
+          document?: Stripe.Emptyable<Options.Document>;
+        }
+
+        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;
+          }
+
+          namespace Document {
+            type AllowedType = 'driving_license' | 'id_card' | 'passport';
+          }
+        }
+
+        interface ProvidedDetails {
+          /**
+           * Email of user being verified
+           */
+          email?: string;
+
+          /**
+           * Phone number of user being verified
+           */
+          phone?: string;
+        }
+
+        interface RelatedPerson {
+          /**
+           * A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
+           */
+          account: string;
+
+          /**
+           * A token referencing a Person resource that this verification is being used to verify.
+           */
+          person: string;
+        }
+
+        type Type = 'document' | 'id_number';
+      }
+
+      interface VerificationSessionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface VerificationSessionUpdateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * A set of options for the session's verification checks.
+         */
+        options?: VerificationSessionUpdateParams.Options;
+
+        /**
+         * Details provided about the user being verified. These details may be shown to the user.
+         */
+        provided_details?: VerificationSessionUpdateParams.ProvidedDetails;
+
+        /**
+         * The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
+         */
+        type?: VerificationSessionUpdateParams.Type;
+      }
+
+      namespace VerificationSessionUpdateParams {
+        interface Options {
+          /**
+           * Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
+           */
+          document?: Stripe.Emptyable<Options.Document>;
+        }
+
+        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;
+          }
+
+          namespace Document {
+            type AllowedType = 'driving_license' | 'id_card' | 'passport';
+          }
+        }
+
+        interface ProvidedDetails {
+          /**
+           * Email of user being verified
+           */
+          email?: string;
+
+          /**
+           * Phone number of user being verified
+           */
+          phone?: string;
+        }
+
+        type Type = 'document' | 'id_number';
+      }
+
+      interface VerificationSessionListParams extends PaginationParams {
+        /**
+         * 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.
+         */
+        client_reference_id?: string;
+
+        /**
+         * Only return VerificationSessions that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Customer ID
+         */
+        related_customer?: string;
+
+        /**
+         * The ID of the Account representing a customer.
+         */
+        related_customer_account?: string;
+
+        /**
+         * Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
+         */
+        status?: VerificationSessionListParams.Status;
+      }
+
+      namespace VerificationSessionListParams {
+        type Status = 'canceled' | 'processing' | 'requires_input' | 'verified';
+      }
+
+      interface VerificationSessionCancelParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface VerificationSessionRedactParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class VerificationSessionsResource {
+        /**
+         * Creates a VerificationSession object.
+         *
+         * After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
+         *
+         * If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
+         *
+         * Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
+         */
+        create(
+          params?: VerificationSessionCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+        create(
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+
+        /**
+         * Retrieves the details of a VerificationSession that was previously created.
+         *
+         * When the session status is requires_input, you can use this method to retrieve a valid
+         * client_secret or url to allow re-submission.
+         */
+        retrieve(
+          id: string,
+          params?: VerificationSessionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+
+        /**
+         * Updates a VerificationSession object.
+         *
+         * When the session status is requires_input, you can use this method to update the
+         * verification check and options.
+         */
+        update(
+          id: string,
+          params?: VerificationSessionUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+
+        /**
+         * Returns a list of VerificationSessions
+         */
+        list(
+          params?: VerificationSessionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Identity.VerificationSession>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Identity.VerificationSession>;
+
+        /**
+         * A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
+         *
+         * Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
+         */
+        cancel(
+          id: string,
+          params?: VerificationSessionCancelParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+        cancel(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+
+        /**
+         * Redact a VerificationSession to remove all collected information from Stripe. This will redact
+         * the VerificationSession and all objects related to it, including VerificationReports, Events,
+         * request logs, etc.
+         *
+         * A VerificationSession object can be redacted when it is in requires_input or verified
+         * [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+         * state will automatically cancel it.
+         *
+         * The redaction process may take up to four days. When the redaction process is in progress, the
+         * VerificationSession's redaction.status field will be set to processing; when the process is
+         * finished, it will change to redacted and an identity.verification_session.redacted event
+         * will be emitted.
+         *
+         * Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
+         * fields that contain personal data will be replaced by the string [redacted] or a similar
+         * placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
+         * used for any purpose.
+         *
+         * [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
+         */
+        redact(
+          id: string,
+          params?: VerificationSessionRedactParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+        redact(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Identity.VerificationSession>>;
+      }
+    }
+  }
+}

package/types/InvoiceItems.d.ts

@@ -0,0 +1,240 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The DeletedInvoiceItem object.
+     */
+    interface DeletedInvoiceItem {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'invoiceitem';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+    }
+
+    /**
+     * Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines).
+     *
+     * Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
+     * with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
+     * or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges
+     * (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
+     *
+     * Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).
+     */
+    interface InvoiceItem {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'invoiceitem';
+
+      /**
+       * Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
+       */
+      amount: number;
+
+      /**
+       * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * The ID of the customer to bill for this invoice item.
+       */
+      customer: string | Stripe.Customer | Stripe.DeletedCustomer;
+
+      /**
+       * The ID of the account to bill for this invoice item.
+       */
+      customer_account: string | null;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      date: number;
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * If true, discounts will apply to this invoice item. Always false for prorations.
+       */
+      discountable: boolean;
+
+      /**
+       * The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
+       */
+      discounts: Array<string | Stripe.Discount> | null;
+
+      /**
+       * The ID of the invoice this invoice item belongs to.
+       */
+      invoice: string | Stripe.Invoice | null;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+       */
+      metadata: Stripe.Metadata | null;
+
+      /**
+       * The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.
+       */
+      net_amount?: number;
+
+      /**
+       * The parent that generated this invoice item.
+       */
+      parent: InvoiceItem.Parent | null;
+
+      period: InvoiceItem.Period;
+
+      /**
+       * The pricing information of the invoice item.
+       */
+      pricing: InvoiceItem.Pricing | null;
+
+      /**
+       * Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
+       */
+      proration: boolean;
+
+      proration_details?: InvoiceItem.ProrationDetails;
+
+      /**
+       * Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use `quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
+       */
+      quantity: number;
+
+      /**
+       * Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
+       */
+      quantity_decimal: Decimal;
+
+      /**
+       * The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
+       */
+      tax_rates: Array<Stripe.TaxRate> | null;
+
+      /**
+       * ID of the test clock this invoice item belongs to.
+       */
+      test_clock: string | Stripe.TestHelpers.TestClock | null;
+    }
+
+    namespace InvoiceItem {
+      interface Parent {
+        /**
+         * Details about the subscription that generated this invoice item
+         */
+        subscription_details: Parent.SubscriptionDetails | null;
+
+        /**
+         * The type of parent that generated this invoice item
+         */
+        type: 'subscription_details';
+      }
+
+      namespace Parent {
+        interface SubscriptionDetails {
+          /**
+           * The subscription that generated this invoice item
+           */
+          subscription: string;
+
+          /**
+           * The subscription item that generated this invoice item
+           */
+          subscription_item?: string;
+        }
+      }
+
+      interface Period {
+        /**
+         * The end of the period, which must be greater than or equal to the start. This value is inclusive.
+         */
+        end: number;
+
+        /**
+         * The start of the period. This value is inclusive.
+         */
+        start: number;
+      }
+
+      interface Pricing {
+        price_details?: Pricing.PriceDetails;
+
+        /**
+         * The type of the pricing details.
+         */
+        type: 'price_details';
+
+        /**
+         * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
+         */
+        unit_amount_decimal: Decimal | null;
+      }
+
+      namespace Pricing {
+        interface PriceDetails {
+          /**
+           * The ID of the price this item is associated with.
+           */
+          price: string | Stripe.Price;
+
+          /**
+           * The ID of the product this item is associated with.
+           */
+          product: string;
+        }
+      }
+
+      interface ProrationDetails {
+        /**
+         * Discount amounts applied when the proration was created.
+         */
+        discount_amounts: Array<ProrationDetails.DiscountAmount>;
+      }
+
+      namespace ProrationDetails {
+        interface DiscountAmount {
+          /**
+           * The amount, in cents (or local equivalent), of the discount.
+           */
+          amount: number;
+
+          /**
+           * The discount that was applied to get this discount amount.
+           */
+          discount: string | Stripe.Discount | Stripe.DeletedDiscount;
+        }
+      }
+    }
+  }
+}