@depup/stripe 21.0.0-depup.0

package/types/Reporting/ReportTypes.d.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reporting {
+      /**
+       * The Report Type resource corresponds to a particular type of report, such as
+       * the "Activity summary" or "Itemized payouts" reports. These objects are
+       * identified by an ID belonging to a set of enumerated values. See
+       * [API Access to Reports documentation](https://docs.stripe.com/reporting/statements/api)
+       * for those Report Type IDs, along with required and optional parameters.
+       *
+       * Note that certain report types can only be run based on your live-mode data (not test-mode
+       * data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).
+       */
+      interface ReportType {
+        /**
+         * The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reporting.report_type';
+
+        /**
+         * Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
+         */
+        data_available_end: number;
+
+        /**
+         * Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
+         */
+        data_available_start: number;
+
+        /**
+         * List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)
+         */
+        default_columns: Array<string> | 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;
+
+        /**
+         * Human-readable name of the Report Type
+         */
+        name: string;
+
+        /**
+         * When this Report Type was latest updated. Measured in seconds since the Unix epoch.
+         */
+        updated: number;
+
+        /**
+         * Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
+         */
+        version: number;
+      }
+    }
+  }
+}

package/types/Reporting/ReportTypesResource.d.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reporting {
+      interface ReportTypeRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ReportTypeListParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class ReportTypesResource {
+        /**
+         * Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
+         */
+        retrieve(
+          id: string,
+          params?: ReportTypeRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Reporting.ReportType>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Reporting.ReportType>>;
+
+        /**
+         * Returns a full list of Report Types.
+         */
+        list(
+          params?: ReportTypeListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Reporting.ReportType>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Reporting.ReportType>;
+      }
+    }
+  }
+}

package/types/Reserve/Holds.d.ts

@@ -0,0 +1,104 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      /**
+       * ReserveHolds are used to place a temporary ReserveHold on a merchant's funds.
+       */
+      interface Hold {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reserve.hold';
+
+        /**
+         * Amount reserved. A positive integer representing how much is reserved in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+         */
+        amount: number;
+
+        /**
+         * Amount in cents that can be released from this ReserveHold
+         */
+        amount_releasable?: number;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Indicates which party created this ReserveHold.
+         */
+        created_by: Hold.CreatedBy;
+
+        /**
+         * 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;
+
+        /**
+         * Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet.
+         */
+        is_releasable?: boolean;
+
+        /**
+         * 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;
+
+        /**
+         * The reason for the ReserveHold.
+         */
+        reason: Hold.Reason;
+
+        release_schedule: Hold.ReleaseSchedule;
+
+        /**
+         * The ReservePlan which produced this ReserveHold (i.e., resplan_123)
+         */
+        reserve_plan: string | Stripe.Reserve.Plan | null;
+
+        /**
+         * The Charge which funded this ReserveHold (e.g., ch_123)
+         */
+        source_charge: string | Stripe.Charge | null;
+
+        /**
+         * Which source balance type this ReserveHold reserves funds from. One of `bank_account`, `card`, or `fpx`.
+         */
+        source_type: Hold.SourceType;
+      }
+
+      namespace Hold {
+        type CreatedBy = 'application' | 'stripe';
+
+        type Reason = 'charge' | 'standalone';
+
+        interface ReleaseSchedule {
+          /**
+           * The time after which the ReserveHold is requested to be released.
+           */
+          release_after: number | null;
+
+          /**
+           * The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after `release_after`.
+           */
+          scheduled_release: number | null;
+        }
+
+        type SourceType = 'bank_account' | 'card' | 'fpx';
+      }
+    }
+  }
+}

package/types/Reserve/Plans.d.ts

@@ -0,0 +1,103 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      /**
+       * ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account).
+       */
+      interface Plan {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reserve.plan';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Indicates which party created this ReservePlan.
+         */
+        created_by: Plan.CreatedBy;
+
+        /**
+         * 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). An unset currency indicates that the plan applies to all currencies.
+         */
+        currency: string | null;
+
+        /**
+         * Time at which the ReservePlan was disabled.
+         */
+        disabled_at: number | null;
+
+        fixed_release?: Plan.FixedRelease;
+
+        /**
+         * 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;
+
+        /**
+         * The percent of each Charge to reserve.
+         */
+        percent: number;
+
+        rolling_release?: Plan.RollingRelease;
+
+        /**
+         * The current status of the ReservePlan. The ReservePlan only affects charges if it is `active`.
+         */
+        status: Plan.Status;
+
+        /**
+         * The type of the ReservePlan.
+         */
+        type: Plan.Type;
+      }
+
+      namespace Plan {
+        type CreatedBy = 'application' | 'stripe';
+
+        interface FixedRelease {
+          /**
+           * The time after which all reserved funds are requested for release.
+           */
+          release_after: number;
+
+          /**
+           * The time at which reserved funds are scheduled for release, automatically set to midnight UTC of the day after `release_after`.
+           */
+          scheduled_release: number;
+        }
+
+        interface RollingRelease {
+          /**
+           * The number of days to reserve funds before releasing.
+           */
+          days_after_charge: number;
+
+          /**
+           * The time at which the ReservePlan expires.
+           */
+          expires_on: number | null;
+        }
+
+        type Status = 'active' | 'disabled' | 'expired';
+
+        type Type = 'fixed_release' | 'rolling_release';
+      }
+    }
+  }
+}

package/types/Reserve/Releases.d.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      /**
+       * ReserveReleases represent the release of funds from a ReserveHold.
+       */
+      interface Release {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reserve.release';
+
+        /**
+         * Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+         */
+        amount: number;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Indicates which party created this ReserveRelease.
+         */
+        created_by: Release.CreatedBy;
+
+        /**
+         * 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;
+
+        /**
+         * 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;
+
+        /**
+         * The reason for the ReserveRelease, indicating why the funds were released.
+         */
+        reason: Release.Reason;
+
+        /**
+         * The release timestamp of the funds.
+         */
+        released_at: number;
+
+        /**
+         * The ReserveHold this ReserveRelease is associated with.
+         */
+        reserve_hold: string | Stripe.Reserve.Hold | null;
+
+        /**
+         * The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry.
+         */
+        reserve_plan: string | Stripe.Reserve.Plan | null;
+
+        source_transaction?: Release.SourceTransaction;
+      }
+
+      namespace Release {
+        type CreatedBy = 'application' | 'stripe';
+
+        type Reason =
+          | 'bulk_hold_expiry'
+          | 'hold_released_early'
+          | 'hold_reversed'
+          | 'plan_disabled';
+
+        interface SourceTransaction {
+          /**
+           * The ID of the dispute.
+           */
+          dispute?: string | Stripe.Dispute;
+
+          /**
+           * The ID of the refund.
+           */
+          refund?: string | Stripe.Refund;
+
+          /**
+           * The type of source transaction.
+           */
+          type: SourceTransaction.Type;
+        }
+
+        namespace SourceTransaction {
+          type Type = 'dispute' | 'refund';
+        }
+      }
+    }
+  }
+}

package/types/ReserveTransactions.d.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The ReserveTransaction object.
+     */
+    interface ReserveTransaction {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'reserve_transaction';
+
+      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;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+    }
+  }
+}

package/types/Reviews.d.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Reviews can be used to supplement automated fraud detection with human expertise.
+     *
+     * Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments
+     * [here](https://docs.stripe.com/radar/reviews).
+     */
+    interface Review {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'review';
+
+      /**
+       * The ZIP or postal code of the card used, if applicable.
+       */
+      billing_zip: string | null;
+
+      /**
+       * The charge associated with this review.
+       */
+      charge: string | Stripe.Charge | null;
+
+      /**
+       * The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.
+       */
+      closed_reason: Review.ClosedReason | null;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The IP address where the payment originated.
+       */
+      ip_address: string | null;
+
+      /**
+       * Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
+       */
+      ip_address_location: Review.IpAddressLocation | 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;
+
+      /**
+       * If `true`, the review needs action.
+       */
+      open: boolean;
+
+      /**
+       * The reason the review was opened. One of `rule` or `manual`.
+       */
+      opened_reason: Review.OpenedReason;
+
+      /**
+       * The PaymentIntent ID associated with this review, if one exists.
+       */
+      payment_intent?: string | Stripe.PaymentIntent;
+
+      /**
+       * The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.
+       */
+      reason: string;
+
+      /**
+       * Information related to the browsing session of the user who initiated the payment.
+       */
+      session: Review.Session | null;
+    }
+
+    namespace Review {
+      type ClosedReason =
+        | 'acknowledged'
+        | 'approved'
+        | 'canceled'
+        | 'disputed'
+        | 'payment_never_settled'
+        | 'redacted'
+        | 'refunded'
+        | 'refunded_as_fraud';
+
+      interface IpAddressLocation {
+        /**
+         * The city where the payment originated.
+         */
+        city: string | null;
+
+        /**
+         * Two-letter ISO code representing the country where the payment originated.
+         */
+        country: string | null;
+
+        /**
+         * The geographic latitude where the payment originated.
+         */
+        latitude: number | null;
+
+        /**
+         * The geographic longitude where the payment originated.
+         */
+        longitude: number | null;
+
+        /**
+         * The state/county/province/region where the payment originated.
+         */
+        region: string | null;
+      }
+
+      type OpenedReason = 'manual' | 'rule';
+
+      interface Session {
+        /**
+         * The browser used in this browser session (e.g., `Chrome`).
+         */
+        browser: string | null;
+
+        /**
+         * Information about the device used for the browser session (e.g., `Samsung SM-G930T`).
+         */
+        device: string | null;
+
+        /**
+         * The platform for the browser session (e.g., `Macintosh`).
+         */
+        platform: string | null;
+
+        /**
+         * The version for the browser session (e.g., `61.0.3163.100`).
+         */
+        version: string | null;
+      }
+    }
+  }
+}

package/types/ReviewsResource.d.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ReviewRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ReviewListParams extends PaginationParams {
+      /**
+       * Only return reviews that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ReviewApproveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class ReviewsResource {
+      /**
+       * Retrieves a Review object.
+       */
+      retrieve(
+        id: string,
+        params?: ReviewRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Review>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Review>>;
+
+      /**
+       * Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+       */
+      list(
+        params?: ReviewListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Review>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.Review>;
+
+      /**
+       * Approves a Review object, closing it and removing it from the list of reviews.
+       */
+      approve(
+        id: string,
+        params?: ReviewApproveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Review>>;
+      approve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Review>>;
+    }
+  }
+}