@depup/stripe 21.0.0-depup.0

package/types/ApplePayDomains.d.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The ApplePayDomain object.
+     */
+    interface ApplePayDomain {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'apple_pay_domain';
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      domain_name: 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;
+    }
+
+    /**
+     * The DeletedApplePayDomain object.
+     */
+    interface DeletedApplePayDomain {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'apple_pay_domain';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+    }
+  }
+}

package/types/ApplePayDomainsResource.d.ts

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ApplePayDomainCreateParams {
+      domain_name: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ApplePayDomainRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ApplePayDomainListParams extends PaginationParams {
+      domain_name?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ApplePayDomainDeleteParams {}
+
+    class ApplePayDomainsResource {
+      /**
+       * Create an apple pay domain.
+       */
+      create(
+        params: ApplePayDomainCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ApplePayDomain>>;
+
+      /**
+       * Retrieve an apple pay domain.
+       */
+      retrieve(
+        id: string,
+        params?: ApplePayDomainRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ApplePayDomain>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ApplePayDomain>>;
+
+      /**
+       * List apple pay domains.
+       */
+      list(
+        params?: ApplePayDomainListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.ApplePayDomain>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.ApplePayDomain>;
+
+      /**
+       * Delete an apple pay domain.
+       */
+      del(
+        id: string,
+        params?: ApplePayDomainDeleteParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.DeletedApplePayDomain>>;
+      del(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.DeletedApplePayDomain>>;
+    }
+  }
+}

package/types/ApplicationFees.d.ts

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The ApplicationFee object.
+     */
+    interface ApplicationFee {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'application_fee';
+
+      /**
+       * ID of the Stripe account this fee was taken from.
+       */
+      account: string | Stripe.Account;
+
+      /**
+       * Amount earned, in cents (or local equivalent).
+       */
+      amount: number;
+
+      /**
+       * Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
+       */
+      amount_refunded: number;
+
+      /**
+       * ID of the Connect application that earned the fee.
+       */
+      application: string | Stripe.Application;
+
+      /**
+       * Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
+       */
+      balance_transaction: string | Stripe.BalanceTransaction | null;
+
+      /**
+       * ID of the charge that the application fee was taken from.
+       */
+      charge: string | Stripe.Charge;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: 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;
+
+      /**
+       * Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
+       */
+      fee_source: ApplicationFee.FeeSource | 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;
+
+      /**
+       * ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.
+       */
+      originating_transaction: string | Stripe.Charge | null;
+
+      /**
+       * Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
+       */
+      refunded: boolean;
+
+      /**
+       * A list of refunds that have been applied to the fee.
+       */
+      refunds: ApiList<Stripe.FeeRefund>;
+    }
+
+    namespace ApplicationFee {
+      interface FeeSource {
+        /**
+         * Charge ID that created this application fee.
+         */
+        charge?: string;
+
+        /**
+         * Payout ID that created this application fee.
+         */
+        payout?: string;
+
+        /**
+         * Type of object that created the application fee.
+         */
+        type: FeeSource.Type;
+      }
+
+      namespace FeeSource {
+        type Type = 'charge' | 'payout';
+      }
+    }
+  }
+}

package/types/ApplicationFeesResource.d.ts

@@ -0,0 +1,162 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ApplicationFeeRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ApplicationFeeListParams extends PaginationParams {
+      /**
+       * Only return application fees for the charge specified by this charge ID.
+       */
+      charge?: string;
+
+      /**
+       * Only return applications fees 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 ApplicationFeeCreateRefundParams {
+      /**
+       * A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
+       */
+      amount?: number;
+
+      /**
+       * 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;
+    }
+
+    interface ApplicationFeeListRefundsParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ApplicationFeeRetrieveRefundParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ApplicationFeeUpdateRefundParams {
+      /**
+       * 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.Emptyable<Stripe.MetadataParam>;
+    }
+
+    class ApplicationFeesResource {
+      /**
+       * Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
+       */
+      retrieve(
+        id: string,
+        params?: ApplicationFeeRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ApplicationFee>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ApplicationFee>>;
+
+      /**
+       * Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
+       */
+      list(
+        params?: ApplicationFeeListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.ApplicationFee>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.ApplicationFee>;
+
+      /**
+       * Refunds an application fee that has previously been collected but not yet refunded.
+       * Funds will be refunded to the Stripe account from which the fee was originally collected.
+       *
+       * You can optionally refund only part of an application fee.
+       * You can do so multiple times, until the entire fee has been refunded.
+       *
+       * Once entirely refunded, an application fee can't be refunded again.
+       * This method will raise an error when called on an already-refunded application fee,
+       * or when trying to refund more money than is left on an application fee.
+       */
+      createRefund(
+        id: string,
+        params?: ApplicationFeeCreateRefundParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FeeRefund>>;
+      createRefund(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FeeRefund>>;
+
+      /**
+       * You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
+       */
+      listRefunds(
+        id: string,
+        params?: ApplicationFeeListRefundsParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.FeeRefund>;
+      listRefunds(
+        id: string,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.FeeRefund>;
+
+      /**
+       * By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
+       */
+      retrieveRefund(
+        feeId: string,
+        id: string,
+        params?: ApplicationFeeRetrieveRefundParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FeeRefund>>;
+      retrieveRefund(
+        feeId: string,
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FeeRefund>>;
+
+      /**
+       * Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+       *
+       * This request only accepts metadata as an argument.
+       */
+      updateRefund(
+        feeId: string,
+        id: string,
+        params?: ApplicationFeeUpdateRefundParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FeeRefund>>;
+      updateRefund(
+        feeId: string,
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FeeRefund>>;
+    }
+  }
+}

package/types/Applications.d.ts

@@ -0,0 +1,55 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The Application object.
+     */
+    interface Application {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'application';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      /**
+       * The name of the application.
+       */
+      name: string | null;
+    }
+
+    /**
+     * The DeletedApplication object.
+     */
+    interface DeletedApplication {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'application';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+
+      /**
+       * The name of the application.
+       */
+      name: string | null;
+    }
+  }
+}

package/types/Apps/Secrets.d.ts

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Apps {
+      /**
+       * Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
+       *
+       * The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
+       *
+       * All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
+       *
+       * A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
+       *
+       * Related guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects)
+       */
+      interface Secret {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'apps.secret';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * If true, indicates that this secret has been deleted
+         */
+        deleted?: boolean;
+
+        /**
+         * The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+         */
+        expires_at: number | 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;
+
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * The plaintext secret value to be stored.
+         */
+        payload?: string | null;
+
+        scope: Secret.Scope;
+      }
+
+      namespace Secret {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID, if type is set to "user"
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+    }
+  }
+}