stripe 18.5.0 → 18.6.0-alpha.2

package/types/V2/Core/ClaimableSandboxes.d.ts

@@ -0,0 +1,387 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        /**
+         * A claimable sandbox represents a Stripe sandbox that is anonymous.
+         * When it is created, it can be prefilled with specific metadata, such as email, name, or country.
+         * Claimable sandboxes can be claimed through a URL. When a user claims a sandbox through this URL,
+         * it will prompt them to create a new Stripe account. Or, it will allow them to claim this sandbox in their
+         * existing Stripe account.
+         * Claimable sandboxes have 60 days to be claimed. After this expiration time has passed,
+         * if the sandbox is not claimed, it will be deleted.
+         */
+        interface ClaimableSandbox {
+          /**
+           * Unique identifier for the Claimable sandbox.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.core.claimable_sandbox';
+
+          /**
+           * URL for user to claim sandbox into their existing Stripe account.
+           * The value will be null if the sandbox status is `claimed` or `expired`.
+           */
+          claim_url: string | null;
+
+          /**
+           * The timestamp the sandbox was claimed. The value will be null if the sandbox status is not `claimed`.
+           */
+          claimed_at: string | null;
+
+          /**
+           * When the sandbox is created.
+           */
+          created: string;
+
+          /**
+           * The timestamp the sandbox will expire. The value will be null if the sandbox is `claimed`.
+           */
+          expires_at: string | 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;
+
+          /**
+           * Values prefilled during the creation of the sandbox.
+           */
+          prefill: ClaimableSandbox.Prefill;
+
+          /**
+           * Data about the Stripe sandbox object.
+           */
+          sandbox_details: ClaimableSandbox.SandboxDetails;
+
+          /**
+           * Status of the sandbox. One of `unclaimed`, `expired`, `claimed`.
+           */
+          status: ClaimableSandbox.Status;
+        }
+
+        namespace ClaimableSandbox {
+          interface Prefill {
+            /**
+             * Country in which the account holder resides, or in which the business is legally established.
+             * Use two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+             */
+            country: Prefill.Country;
+
+            /**
+             * Email that this sandbox is meant to be claimed by. Stripe will
+             * send an email to this email address before the sandbox expires.
+             */
+            email: string;
+
+            /**
+             * Name for the sandbox.
+             */
+            name: string;
+          }
+
+          namespace Prefill {
+            type Country =
+              | 'ad'
+              | 'ae'
+              | 'af'
+              | 'ag'
+              | 'ai'
+              | 'al'
+              | 'am'
+              | 'ao'
+              | 'aq'
+              | 'ar'
+              | 'as'
+              | 'at'
+              | 'au'
+              | 'aw'
+              | 'ax'
+              | 'az'
+              | 'ba'
+              | 'bb'
+              | 'bd'
+              | 'be'
+              | 'bf'
+              | 'bg'
+              | 'bh'
+              | 'bi'
+              | 'bj'
+              | 'bl'
+              | 'bm'
+              | 'bn'
+              | 'bo'
+              | 'bq'
+              | 'br'
+              | 'bs'
+              | 'bt'
+              | 'bv'
+              | 'bw'
+              | 'by'
+              | 'bz'
+              | 'ca'
+              | 'cc'
+              | 'cd'
+              | 'cf'
+              | 'cg'
+              | 'ch'
+              | 'ci'
+              | 'ck'
+              | 'cl'
+              | 'cm'
+              | 'cn'
+              | 'co'
+              | 'cr'
+              | 'cu'
+              | 'cv'
+              | 'cw'
+              | 'cx'
+              | 'cy'
+              | 'cz'
+              | 'de'
+              | 'dj'
+              | 'dk'
+              | 'dm'
+              | 'do'
+              | 'dz'
+              | 'ec'
+              | 'ee'
+              | 'eg'
+              | 'eh'
+              | 'er'
+              | 'es'
+              | 'et'
+              | 'fi'
+              | 'fj'
+              | 'fk'
+              | 'fm'
+              | 'fo'
+              | 'fr'
+              | 'ga'
+              | 'gb'
+              | 'gd'
+              | 'ge'
+              | 'gf'
+              | 'gg'
+              | 'gh'
+              | 'gi'
+              | 'gl'
+              | 'gm'
+              | 'gn'
+              | 'gp'
+              | 'gq'
+              | 'gr'
+              | 'gs'
+              | 'gt'
+              | 'gu'
+              | 'gw'
+              | 'gy'
+              | 'hk'
+              | 'hm'
+              | 'hn'
+              | 'hr'
+              | 'ht'
+              | 'hu'
+              | 'id'
+              | 'ie'
+              | 'il'
+              | 'im'
+              | 'in'
+              | 'io'
+              | 'iq'
+              | 'ir'
+              | 'is'
+              | 'it'
+              | 'je'
+              | 'jm'
+              | 'jo'
+              | 'jp'
+              | 'ke'
+              | 'kg'
+              | 'kh'
+              | 'ki'
+              | 'km'
+              | 'kn'
+              | 'kp'
+              | 'kr'
+              | 'kw'
+              | 'ky'
+              | 'kz'
+              | 'la'
+              | 'lb'
+              | 'lc'
+              | 'li'
+              | 'lk'
+              | 'lr'
+              | 'ls'
+              | 'lt'
+              | 'lu'
+              | 'lv'
+              | 'ly'
+              | 'ma'
+              | 'mc'
+              | 'md'
+              | 'me'
+              | 'mf'
+              | 'mg'
+              | 'mh'
+              | 'mk'
+              | 'ml'
+              | 'mm'
+              | 'mn'
+              | 'mo'
+              | 'mp'
+              | 'mq'
+              | 'mr'
+              | 'ms'
+              | 'mt'
+              | 'mu'
+              | 'mv'
+              | 'mw'
+              | 'mx'
+              | 'my'
+              | 'mz'
+              | 'na'
+              | 'nc'
+              | 'ne'
+              | 'nf'
+              | 'ng'
+              | 'ni'
+              | 'nl'
+              | 'no'
+              | 'np'
+              | 'nr'
+              | 'nu'
+              | 'nz'
+              | 'om'
+              | 'pa'
+              | 'pe'
+              | 'pf'
+              | 'pg'
+              | 'ph'
+              | 'pk'
+              | 'pl'
+              | 'pm'
+              | 'pn'
+              | 'pr'
+              | 'ps'
+              | 'pt'
+              | 'pw'
+              | 'py'
+              | 'qa'
+              | 'qz'
+              | 're'
+              | 'ro'
+              | 'rs'
+              | 'ru'
+              | 'rw'
+              | 'sa'
+              | 'sb'
+              | 'sc'
+              | 'sd'
+              | 'se'
+              | 'sg'
+              | 'sh'
+              | 'si'
+              | 'sj'
+              | 'sk'
+              | 'sl'
+              | 'sm'
+              | 'sn'
+              | 'so'
+              | 'sr'
+              | 'ss'
+              | 'st'
+              | 'sv'
+              | 'sx'
+              | 'sy'
+              | 'sz'
+              | 'tc'
+              | 'td'
+              | 'tf'
+              | 'tg'
+              | 'th'
+              | 'tj'
+              | 'tk'
+              | 'tl'
+              | 'tm'
+              | 'tn'
+              | 'to'
+              | 'tr'
+              | 'tt'
+              | 'tv'
+              | 'tw'
+              | 'tz'
+              | 'ua'
+              | 'ug'
+              | 'um'
+              | 'us'
+              | 'uy'
+              | 'uz'
+              | 'va'
+              | 'vc'
+              | 've'
+              | 'vg'
+              | 'vi'
+              | 'vn'
+              | 'vu'
+              | 'wf'
+              | 'ws'
+              | 'xx'
+              | 'ye'
+              | 'yt'
+              | 'za'
+              | 'zm'
+              | 'zw';
+          }
+
+          interface SandboxDetails {
+            /**
+             * The sandbox's Stripe account ID.
+             */
+            account: string;
+
+            /**
+             * Keys that can be used to set up an integration for this sandbox and operate on the account.
+             */
+            api_keys: SandboxDetails.ApiKeys | null;
+
+            /**
+             * The livemode sandbox Stripe account ID. This field is only set if the user activates their sandbox
+             * and chooses to install your platform's Stripe App in their live account.
+             */
+            owner_account: string | null;
+          }
+
+          namespace SandboxDetails {
+            interface ApiKeys {
+              /**
+               * Used to communicate with [Stripe's MCP server](https://docs.stripe.com/mcp).
+               * This allows LLM agents to securely operate on a Stripe account.
+               */
+              mcp: string | null;
+
+              /**
+               * Publicly accessible in a web or mobile app client-side code.
+               */
+              publishable: string;
+
+              /**
+               * Should be stored securely in server-side code (such as an environment variable).
+               */
+              secret: string;
+            }
+          }
+
+          type Status = 'claimed' | 'expired' | 'unclaimed';
+        }
+      }
+    }
+  }
+}

package/types/V2/Core/ClaimableSandboxesResource.d.ts

@@ -0,0 +1,329 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        interface ClaimableSandboxCreateParams {
+          /**
+           * If true, returns a key that can be used with [Stripe's MCP server](https://docs.stripe.com/mcp).
+           */
+          enable_mcp_access: boolean;
+
+          /**
+           * Values that are prefilled when a user claims the sandbox.
+           */
+          prefill: ClaimableSandboxCreateParams.Prefill;
+        }
+
+        namespace ClaimableSandboxCreateParams {
+          interface Prefill {
+            /**
+             * Country in which the account holder resides, or in which the business is legally established.
+             * Use two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+             */
+            country: Prefill.Country;
+
+            /**
+             * Email that this sandbox is meant to be claimed by. Stripe will
+             * notify this email address before the sandbox expires.
+             */
+            email: string;
+
+            /**
+             * Name for the sandbox. If not provided, this will be generated.
+             */
+            name?: string;
+          }
+
+          namespace Prefill {
+            type Country =
+              | 'ad'
+              | 'ae'
+              | 'af'
+              | 'ag'
+              | 'ai'
+              | 'al'
+              | 'am'
+              | 'ao'
+              | 'aq'
+              | 'ar'
+              | 'as'
+              | 'at'
+              | 'au'
+              | 'aw'
+              | 'ax'
+              | 'az'
+              | 'ba'
+              | 'bb'
+              | 'bd'
+              | 'be'
+              | 'bf'
+              | 'bg'
+              | 'bh'
+              | 'bi'
+              | 'bj'
+              | 'bl'
+              | 'bm'
+              | 'bn'
+              | 'bo'
+              | 'bq'
+              | 'br'
+              | 'bs'
+              | 'bt'
+              | 'bv'
+              | 'bw'
+              | 'by'
+              | 'bz'
+              | 'ca'
+              | 'cc'
+              | 'cd'
+              | 'cf'
+              | 'cg'
+              | 'ch'
+              | 'ci'
+              | 'ck'
+              | 'cl'
+              | 'cm'
+              | 'cn'
+              | 'co'
+              | 'cr'
+              | 'cu'
+              | 'cv'
+              | 'cw'
+              | 'cx'
+              | 'cy'
+              | 'cz'
+              | 'de'
+              | 'dj'
+              | 'dk'
+              | 'dm'
+              | 'do'
+              | 'dz'
+              | 'ec'
+              | 'ee'
+              | 'eg'
+              | 'eh'
+              | 'er'
+              | 'es'
+              | 'et'
+              | 'fi'
+              | 'fj'
+              | 'fk'
+              | 'fm'
+              | 'fo'
+              | 'fr'
+              | 'ga'
+              | 'gb'
+              | 'gd'
+              | 'ge'
+              | 'gf'
+              | 'gg'
+              | 'gh'
+              | 'gi'
+              | 'gl'
+              | 'gm'
+              | 'gn'
+              | 'gp'
+              | 'gq'
+              | 'gr'
+              | 'gs'
+              | 'gt'
+              | 'gu'
+              | 'gw'
+              | 'gy'
+              | 'hk'
+              | 'hm'
+              | 'hn'
+              | 'hr'
+              | 'ht'
+              | 'hu'
+              | 'id'
+              | 'ie'
+              | 'il'
+              | 'im'
+              | 'in'
+              | 'io'
+              | 'iq'
+              | 'ir'
+              | 'is'
+              | 'it'
+              | 'je'
+              | 'jm'
+              | 'jo'
+              | 'jp'
+              | 'ke'
+              | 'kg'
+              | 'kh'
+              | 'ki'
+              | 'km'
+              | 'kn'
+              | 'kp'
+              | 'kr'
+              | 'kw'
+              | 'ky'
+              | 'kz'
+              | 'la'
+              | 'lb'
+              | 'lc'
+              | 'li'
+              | 'lk'
+              | 'lr'
+              | 'ls'
+              | 'lt'
+              | 'lu'
+              | 'lv'
+              | 'ly'
+              | 'ma'
+              | 'mc'
+              | 'md'
+              | 'me'
+              | 'mf'
+              | 'mg'
+              | 'mh'
+              | 'mk'
+              | 'ml'
+              | 'mm'
+              | 'mn'
+              | 'mo'
+              | 'mp'
+              | 'mq'
+              | 'mr'
+              | 'ms'
+              | 'mt'
+              | 'mu'
+              | 'mv'
+              | 'mw'
+              | 'mx'
+              | 'my'
+              | 'mz'
+              | 'na'
+              | 'nc'
+              | 'ne'
+              | 'nf'
+              | 'ng'
+              | 'ni'
+              | 'nl'
+              | 'no'
+              | 'np'
+              | 'nr'
+              | 'nu'
+              | 'nz'
+              | 'om'
+              | 'pa'
+              | 'pe'
+              | 'pf'
+              | 'pg'
+              | 'ph'
+              | 'pk'
+              | 'pl'
+              | 'pm'
+              | 'pn'
+              | 'pr'
+              | 'ps'
+              | 'pt'
+              | 'pw'
+              | 'py'
+              | 'qa'
+              | 'qz'
+              | 're'
+              | 'ro'
+              | 'rs'
+              | 'ru'
+              | 'rw'
+              | 'sa'
+              | 'sb'
+              | 'sc'
+              | 'sd'
+              | 'se'
+              | 'sg'
+              | 'sh'
+              | 'si'
+              | 'sj'
+              | 'sk'
+              | 'sl'
+              | 'sm'
+              | 'sn'
+              | 'so'
+              | 'sr'
+              | 'ss'
+              | 'st'
+              | 'sv'
+              | 'sx'
+              | 'sy'
+              | 'sz'
+              | 'tc'
+              | 'td'
+              | 'tf'
+              | 'tg'
+              | 'th'
+              | 'tj'
+              | 'tk'
+              | 'tl'
+              | 'tm'
+              | 'tn'
+              | 'to'
+              | 'tr'
+              | 'tt'
+              | 'tv'
+              | 'tw'
+              | 'tz'
+              | 'ua'
+              | 'ug'
+              | 'um'
+              | 'us'
+              | 'uy'
+              | 'uz'
+              | 'va'
+              | 'vc'
+              | 've'
+              | 'vg'
+              | 'vi'
+              | 'vn'
+              | 'vu'
+              | 'wf'
+              | 'ws'
+              | 'xx'
+              | 'ye'
+              | 'yt'
+              | 'za'
+              | 'zm'
+              | 'zw';
+          }
+        }
+      }
+
+      namespace Core {
+        interface ClaimableSandboxRetrieveParams {}
+      }
+
+      namespace Core {
+        class ClaimableSandboxesResource {
+          /**
+           * Create an anonymous, claimable sandbox. This sandbox can be prefilled with data. The response will include
+           * a claim URL that allow a user to claim the account.
+           */
+          create(
+            params: ClaimableSandboxCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Core.ClaimableSandbox>>;
+
+          /**
+           * Retrieves the details of a claimable sandbox that was previously been created.
+           * Supply the unique claimable sandbox ID that was returned from your creation request,
+           * and Stripe will return the corresponding sandbox information.
+           */
+          retrieve(
+            id: string,
+            params?: ClaimableSandboxRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Core.ClaimableSandbox>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Core.ClaimableSandbox>>;
+        }
+      }
+    }
+  }
+}