stripe 16.6.0-beta.1 → 16.6.0

package/types/AccountNotices.d.ts

@@ -1,113 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    /**
-     * A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
-     *
-     * See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
-     */
-    interface AccountNotice {
-      /**
-       * Unique identifier for the object.
-       */
-      id: string;
-
-      /**
-       * String representing the object's type. Objects of the same type share the same value.
-       */
-      object: 'account_notice';
-
-      /**
-       * Time at which the object was created. Measured in seconds since the Unix epoch.
-       */
-      created: number;
-
-      /**
-       * When present, the deadline for sending the notice to meet the relevant regulations.
-       */
-      deadline: number | null;
-
-      /**
-       * Information about the email when sent.
-       */
-      email: AccountNotice.Email | null;
-
-      /**
-       * Information about objects related to the notice.
-       */
-      linked_objects: AccountNotice.LinkedObjects | null;
-
-      /**
-       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-       */
-      livemode: boolean;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/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;
-
-      /**
-       * Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
-       */
-      reason: AccountNotice.Reason;
-
-      /**
-       * Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
-       */
-      sent_at: number | null;
-    }
-
-    namespace AccountNotice {
-      interface Email {
-        /**
-         * Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
-         */
-        plain_text: string;
-
-        /**
-         * Email address of the recipient.
-         */
-        recipient: string;
-
-        /**
-         * Subject of the email.
-         */
-        subject: string;
-      }
-
-      interface LinkedObjects {
-        /**
-         * Associated [Capability](https://stripe.com/docs/api/capabilities)
-         */
-        capability: string | null;
-
-        /**
-         * Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)
-         */
-        issuing_credit_underwriting_record?: string | null;
-
-        /**
-         * Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)
-         */
-        issuing_dispute: string | null;
-      }
-
-      type Reason =
-        | 'issuing.account_closed_for_inactivity'
-        | 'issuing.account_closed_for_not_providing_business_model_clarification'
-        | 'issuing.account_closed_for_not_providing_url_clarification'
-        | 'issuing.account_closed_for_not_providing_use_case_clarification'
-        | 'issuing.account_closed_for_terms_of_service_violation'
-        | 'issuing.application_rejected_for_failure_to_verify'
-        | 'issuing.credit_application_rejected'
-        | 'issuing.credit_increase_application_rejected'
-        | 'issuing.credit_limit_decreased'
-        | 'issuing.credit_line_closed'
-        | 'issuing.dispute_lost'
-        | 'issuing.dispute_submitted'
-        | 'issuing.dispute_won';
-    }
-  }
-}

package/types/AccountNoticesResource.d.ts

@@ -1,98 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    interface AccountNoticeRetrieveParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
-    interface AccountNoticeUpdateParams {
-      /**
-       * Information about the email you sent.
-       */
-      email: AccountNoticeUpdateParams.Email;
-
-      /**
-       * Date when you sent the notice.
-       */
-      sent_at: number;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/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;
-    }
-
-    namespace AccountNoticeUpdateParams {
-      interface Email {
-        /**
-         * Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
-         */
-        plain_text: string;
-
-        /**
-         * Email address of the recipient.
-         */
-        recipient: string;
-
-        /**
-         * Subject of the email.
-         */
-        subject: string;
-      }
-    }
-
-    interface AccountNoticeListParams extends PaginationParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Set to false to only return unsent AccountNotices.
-       */
-      sent?: boolean;
-    }
-
-    class AccountNoticesResource {
-      /**
-       * Retrieves an AccountNotice object.
-       */
-      retrieve(
-        id: string,
-        params?: AccountNoticeRetrieveParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.AccountNotice>>;
-      retrieve(
-        id: string,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.AccountNotice>>;
-
-      /**
-       * Updates an AccountNotice object.
-       */
-      update(
-        id: string,
-        params: AccountNoticeUpdateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.AccountNotice>>;
-
-      /**
-       * Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
-       */
-      list(
-        params?: AccountNoticeListParams,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.AccountNotice>;
-      list(options?: RequestOptions): ApiListPromise<Stripe.AccountNotice>;
-    }
-  }
-}

package/types/Billing/AlertsResource.d.ts

@@ -1,176 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Billing {
-      interface AlertCreateParams {
-        /**
-         * The type of alert to create.
-         */
-        alert_type: 'usage_threshold';
-
-        /**
-         * The title of the alert.
-         */
-        title: string;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * Filters to limit the scope of an alert.
-         */
-        filter?: AlertCreateParams.Filter;
-
-        /**
-         * The configuration of the usage threshold.
-         */
-        usage_threshold_config?: AlertCreateParams.UsageThresholdConfig;
-      }
-
-      namespace AlertCreateParams {
-        interface Filter {
-          /**
-           * Limit the scope to this alert only to this customer.
-           */
-          customer?: string;
-        }
-
-        interface UsageThresholdConfig {
-          /**
-           * Defines at which value the alert will fire.
-           */
-          gte: number;
-
-          /**
-           * The [Billing Meter](https://stripe.com/api/billing/meter) ID whose usage is monitored.
-           */
-          meter?: string;
-
-          /**
-           * Whether the alert should only fire only once, or once per billing cycle.
-           */
-          recurrence: 'one_time';
-        }
-      }
-
-      interface AlertRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface AlertListParams extends PaginationParams {
-        /**
-         * Filter results to only include this type of alert.
-         */
-        alert_type?: 'usage_threshold';
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * Filter results to only include alerts with the given meter.
-         */
-        meter?: string;
-      }
-
-      interface AlertActivateParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface AlertArchiveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface AlertDeactivateParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class AlertsResource {
-        /**
-         * Creates a billing alert
-         */
-        create(
-          params: AlertCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-
-        /**
-         * Retrieves a billing alert given an ID
-         */
-        retrieve(
-          id: string,
-          params?: AlertRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-
-        /**
-         * Lists billing active and inactive alerts
-         */
-        list(
-          params?: AlertListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Billing.Alert>;
-        list(options?: RequestOptions): ApiListPromise<Stripe.Billing.Alert>;
-
-        /**
-         * Reactivates this alert, allowing it to trigger again.
-         */
-        activate(
-          id: string,
-          params?: AlertActivateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-        activate(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-
-        /**
-         * Archives this alert, removing it from the list view and APIs. This is non-reversible.
-         */
-        archive(
-          id: string,
-          params?: AlertArchiveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-        archive(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-
-        /**
-         * Deactivates this alert, preventing it from triggering.
-         */
-        deactivate(
-          id: string,
-          params?: AlertDeactivateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-        deactivate(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
-      }
-    }
-  }
-}

package/types/Capital/FinancingOffers.d.ts

@@ -1,188 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      /**
-       * This is an object representing an offer of financing from
-       * Stripe Capital to a Connect subaccount.
-       */
-      interface FinancingOffer {
-        /**
-         * A unique identifier for the financing object.
-         */
-        id: string;
-
-        /**
-         * The object type: financing_offer.
-         */
-        object: 'capital.financing_offer';
-
-        /**
-         * This is an object representing the terms of an offer of financing from
-         * Stripe Capital to a Connected account. This resource represents
-         * the terms accepted by the Connected account, which may differ from those
-         * offered.
-         */
-        accepted_terms?: FinancingOffer.AcceptedTerms;
-
-        /**
-         * The ID of the merchant associated with this financing object.
-         */
-        account: string;
-
-        /**
-         * The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
-         */
-        charged_off_at?: number;
-
-        /**
-         * Time at which the offer was created. Given in seconds since unix epoch.
-         */
-        created: number;
-
-        /**
-         * Time at which the offer expires. Given in seconds since unix epoch.
-         */
-        expires_after: number;
-
-        /**
-         * The type of financing being offered.
-         */
-        financing_type?: FinancingOffer.FinancingType;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/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;
-
-        /**
-         * This is an object representing the terms of an offer of financing from
-         * Stripe Capital to a Connected account. This resource represents
-         * both the terms offered to the Connected account.
-         */
-        offered_terms?: FinancingOffer.OfferedTerms;
-
-        /**
-         * Financing product identifier.
-         */
-        product_type?: FinancingOffer.ProductType;
-
-        /**
-         * The ID of the financing offer that replaced this offer.
-         */
-        replacement?: string;
-
-        /**
-         * The ID of the financing offer that this offer is a replacement for.
-         */
-        replacement_for?: string;
-
-        /**
-         * The current status of the offer.
-         */
-        status: FinancingOffer.Status;
-
-        /**
-         * See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
-         */
-        type?: FinancingOffer.Type;
-      }
-
-      namespace FinancingOffer {
-        interface AcceptedTerms {
-          /**
-           * Amount of financing offered, in minor units.
-           */
-          advance_amount: number;
-
-          /**
-           * Currency that the financing offer is transacted in. For example, `usd`.
-           */
-          currency: string;
-
-          /**
-           * Fixed fee amount, in minor units.
-           */
-          fee_amount: number;
-
-          /**
-           * Populated when the `product_type` of the `financingoffer` is `refill`.
-           * Represents the discount amount on remaining premium for the existing loan at payout time.
-           */
-          previous_financing_fee_discount_amount: number | null;
-
-          /**
-           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
-           */
-          withhold_rate: number;
-        }
-
-        type FinancingType = 'cash_advance' | 'flex_loan';
-
-        interface OfferedTerms {
-          /**
-           * Amount of financing offered, in minor units.
-           */
-          advance_amount: number;
-
-          /**
-           * Describes the type of user the offer is being extended to.
-           */
-          campaign_type: OfferedTerms.CampaignType;
-
-          /**
-           * Currency that the financing offer is transacted in. For example, `usd`.
-           */
-          currency: string;
-
-          /**
-           * Fixed fee amount, in minor units.
-           */
-          fee_amount: number;
-
-          /**
-           * Populated when the `product_type` of the `financingoffer` is `refill`.
-           * Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
-           * is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
-           * and the remaining fee.
-           */
-          previous_financing_fee_discount_rate: number | null;
-
-          /**
-           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
-           */
-          withhold_rate: number;
-        }
-
-        namespace OfferedTerms {
-          type CampaignType =
-            | 'newly_eligible_user'
-            | 'previously_eligible_user'
-            | 'repeat_user';
-        }
-
-        type ProductType = 'refill' | 'standard';
-
-        type Status =
-          | 'accepted'
-          | 'canceled'
-          | 'completed'
-          | 'delivered'
-          | 'expired'
-          | 'fully_repaid'
-          | 'paid_out'
-          | 'rejected'
-          | 'replaced'
-          | 'undelivered';
-
-        type Type = 'cash_advance' | 'flex_loan';
-      }
-    }
-  }
-}

package/types/Capital/FinancingOffersResource.d.ts

@@ -1,97 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Capital {
-      interface FinancingOfferRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface FinancingOfferListParams extends PaginationParams {
-        /**
-         * limit list to offers belonging to given connected account
-         */
-        connected_account?: string;
-
-        /**
-         * Only return offers that were created during the given date interval.
-         */
-        created?: Stripe.RangeQueryParam | number;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * limit list to offers with given status
-         */
-        status?: FinancingOfferListParams.Status;
-      }
-
-      namespace FinancingOfferListParams {
-        type Status =
-          | 'accepted'
-          | 'canceled'
-          | 'completed'
-          | 'delivered'
-          | 'expired'
-          | 'fully_repaid'
-          | 'paid_out'
-          | 'rejected'
-          | 'revoked'
-          | 'undelivered';
-      }
-
-      interface FinancingOfferMarkDeliveredParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class FinancingOffersResource {
-        /**
-         * Get the details of the financing offer
-         */
-        retrieve(
-          id: string,
-          params?: FinancingOfferRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-
-        /**
-         * Retrieves the financing offers available for Connected accounts that belong to your platform.
-         */
-        list(
-          params?: FinancingOfferListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
-
-        /**
-         * Acknowledges that platform has received and delivered the financing_offer to
-         * the intended merchant recipient.
-         */
-        markDelivered(
-          id: string,
-          params?: FinancingOfferMarkDeliveredParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-        markDelivered(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
-      }
-    }
-  }
-}