@depup/stripe 21.0.0-depup.0

package/types/Terminal/ConnectionTokens.d.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      /**
+       * A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
+       *
+       * Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
+       */
+      interface ConnectionToken {
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'terminal.connection_token';
+
+        /**
+         * The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
+         */
+        location?: string;
+
+        /**
+         * Your application should pass this token to the Stripe Terminal SDK.
+         */
+        secret: string;
+      }
+    }
+  }
+}

package/types/Terminal/ConnectionTokensResource.d.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      interface ConnectionTokenCreateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
+         */
+        location?: string;
+      }
+
+      class ConnectionTokensResource {
+        /**
+         * To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
+         */
+        create(
+          params?: ConnectionTokenCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.ConnectionToken>>;
+        create(
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.ConnectionToken>>;
+      }
+    }
+  }
+}

package/types/Terminal/Locations.d.ts

@@ -0,0 +1,166 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      /**
+       * The DeletedLocation object.
+       */
+      interface DeletedLocation {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'terminal.location';
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted: true;
+      }
+
+      /**
+       * A Location represents a grouping of readers.
+       *
+       * Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
+       */
+      interface Location {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'terminal.location';
+
+        address: Stripe.Address;
+
+        address_kana?: Location.AddressKana;
+
+        address_kanji?: Location.AddressKanji;
+
+        /**
+         * The ID of a configuration that will be used to customize all readers in this location.
+         */
+        configuration_overrides?: string;
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted?: void;
+
+        /**
+         * The display name of the location.
+         */
+        display_name: string;
+
+        /**
+         * The Kana variation of the display name of the location.
+         */
+        display_name_kana?: string;
+
+        /**
+         * The Kanji variation of the display name of the location.
+         */
+        display_name_kanji?: 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 phone number of the location.
+         */
+        phone?: string;
+      }
+
+      namespace Location {
+        interface AddressKana {
+          /**
+           * City/Ward.
+           */
+          city: string | null;
+
+          /**
+           * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+           */
+          country: string | null;
+
+          /**
+           * Block/Building number.
+           */
+          line1: string | null;
+
+          /**
+           * Building details.
+           */
+          line2: string | null;
+
+          /**
+           * ZIP or postal code.
+           */
+          postal_code: string | null;
+
+          /**
+           * Prefecture.
+           */
+          state: string | null;
+
+          /**
+           * Town/cho-me.
+           */
+          town: string | null;
+        }
+
+        interface AddressKanji {
+          /**
+           * City/Ward.
+           */
+          city: string | null;
+
+          /**
+           * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+           */
+          country: string | null;
+
+          /**
+           * Block/Building number.
+           */
+          line1: string | null;
+
+          /**
+           * Building details.
+           */
+          line2: string | null;
+
+          /**
+           * ZIP or postal code.
+           */
+          postal_code: string | null;
+
+          /**
+           * Prefecture.
+           */
+          state: string | null;
+
+          /**
+           * Town/cho-me.
+           */
+          town: string | null;
+        }
+      }
+    }
+  }
+}

package/types/Terminal/LocationsResource.d.ts

@@ -0,0 +1,233 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      interface LocationCreateParams {
+        /**
+         * The full address of the location.
+         */
+        address?: LocationCreateParams.Address;
+
+        /**
+         * The Kana variation of the full address of the location (Japan only).
+         */
+        address_kana?: Stripe.JapanAddressParam;
+
+        /**
+         * The Kanji variation of the full address of the location (Japan only).
+         */
+        address_kanji?: Stripe.JapanAddressParam;
+
+        /**
+         * The ID of a configuration that will be used to customize all readers in this location.
+         */
+        configuration_overrides?: string;
+
+        /**
+         * A name for the location. Maximum length is 1000 characters.
+         */
+        display_name?: string;
+
+        /**
+         * The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters.
+         */
+        display_name_kana?: string;
+
+        /**
+         * The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters.
+         */
+        display_name_kanji?: 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.Emptyable<Stripe.MetadataParam>;
+
+        /**
+         * The phone number for the location.
+         */
+        phone?: string;
+      }
+
+      namespace LocationCreateParams {
+        interface Address {
+          /**
+           * City, district, suburb, town, or village.
+           */
+          city?: string;
+
+          /**
+           * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+           */
+          country: string;
+
+          /**
+           * Address line 1, such as the street, PO Box, or company name.
+           */
+          line1?: string;
+
+          /**
+           * Address line 2, such as the apartment, suite, unit, or building.
+           */
+          line2?: string;
+
+          /**
+           * ZIP or postal code.
+           */
+          postal_code?: string;
+
+          /**
+           * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+           */
+          state?: string;
+        }
+      }
+
+      interface LocationRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface LocationUpdateParams {
+        /**
+         * The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.
+         */
+        address?: Stripe.AddressParam;
+
+        /**
+         * The Kana variation of the full address of the location (Japan only).
+         */
+        address_kana?: Stripe.JapanAddressParam;
+
+        /**
+         * The Kanji variation of the full address of the location (Japan only).
+         */
+        address_kanji?: Stripe.JapanAddressParam;
+
+        /**
+         * The ID of a configuration that will be used to customize all readers in this location.
+         */
+        configuration_overrides?: Stripe.Emptyable<string>;
+
+        /**
+         * A name for the location.
+         */
+        display_name?: Stripe.Emptyable<string>;
+
+        /**
+         * The Kana variation of the name for the location (Japan only).
+         */
+        display_name_kana?: Stripe.Emptyable<string>;
+
+        /**
+         * The Kanji variation of the name for the location (Japan only).
+         */
+        display_name_kanji?: Stripe.Emptyable<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.Emptyable<Stripe.MetadataParam>;
+
+        /**
+         * The phone number for the location.
+         */
+        phone?: Stripe.Emptyable<string>;
+      }
+
+      interface LocationListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface LocationDeleteParams {}
+
+      class LocationsResource {
+        /**
+         * Creates a new Location object.
+         * For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide.
+         */
+        create(
+          params?: LocationCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Location>>;
+        create(
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Location>>;
+
+        /**
+         * Retrieves a Location object.
+         */
+        retrieve(
+          id: string,
+          params?: LocationRetrieveParams,
+          options?: RequestOptions
+        ): Promise<
+          Stripe.Response<
+            Stripe.Terminal.Location | Stripe.Terminal.DeletedLocation
+          >
+        >;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<
+          Stripe.Response<
+            Stripe.Terminal.Location | Stripe.Terminal.DeletedLocation
+          >
+        >;
+
+        /**
+         * Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         */
+        update(
+          id: string,
+          params?: LocationUpdateParams,
+          options?: RequestOptions
+        ): Promise<
+          Stripe.Response<
+            Stripe.Terminal.Location | Stripe.Terminal.DeletedLocation
+          >
+        >;
+
+        /**
+         * Returns a list of Location objects.
+         */
+        list(
+          params?: LocationListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Terminal.Location>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Terminal.Location>;
+
+        /**
+         * Deletes a Location object.
+         */
+        del(
+          id: string,
+          params?: LocationDeleteParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.DeletedLocation>>;
+        del(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.DeletedLocation>>;
+      }
+    }
+  }
+}

package/types/Terminal/OnboardingLinks.d.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      /**
+       * Returns redirect links used for onboarding onto Tap to Pay on iPhone.
+       */
+      interface OnboardingLink {
+        object: 'terminal.onboarding_link';
+
+        /**
+         * Link type options associated with the current onboarding link object.
+         */
+        link_options: OnboardingLink.LinkOptions;
+
+        /**
+         * The type of link being generated.
+         */
+        link_type: 'apple_terms_and_conditions';
+
+        /**
+         * Stripe account ID to generate the link for.
+         */
+        on_behalf_of: string | null;
+
+        /**
+         * The link passed back to the user for their onboarding.
+         */
+        redirect_url: string;
+      }
+
+      namespace OnboardingLink {
+        interface LinkOptions {
+          /**
+           * The options associated with the Apple Terms and Conditions link type.
+           */
+          apple_terms_and_conditions: LinkOptions.AppleTermsAndConditions | null;
+        }
+
+        namespace LinkOptions {
+          interface AppleTermsAndConditions {
+            /**
+             * Whether the link should also support users relinking their Apple account.
+             */
+            allow_relinking: boolean | null;
+
+            /**
+             * The business name of the merchant accepting Apple's Terms and Conditions.
+             */
+            merchant_display_name: string;
+          }
+        }
+      }
+    }
+  }
+}

package/types/Terminal/OnboardingLinksResource.d.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      interface OnboardingLinkCreateParams {
+        /**
+         * Specific fields needed to generate the desired link type.
+         */
+        link_options: OnboardingLinkCreateParams.LinkOptions;
+
+        /**
+         * The type of link being generated.
+         */
+        link_type: 'apple_terms_and_conditions';
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Stripe account ID to generate the link for.
+         */
+        on_behalf_of?: string;
+      }
+
+      namespace OnboardingLinkCreateParams {
+        interface LinkOptions {
+          /**
+           * The options associated with the Apple Terms and Conditions link type.
+           */
+          apple_terms_and_conditions?: LinkOptions.AppleTermsAndConditions;
+        }
+
+        namespace LinkOptions {
+          interface AppleTermsAndConditions {
+            /**
+             * Whether the link should also support users relinking their Apple account.
+             */
+            allow_relinking?: boolean;
+
+            /**
+             * The business name of the merchant accepting Apple's Terms and Conditions.
+             */
+            merchant_display_name: string;
+          }
+        }
+      }
+
+      class OnboardingLinksResource {
+        /**
+         * Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
+         */
+        create(
+          params: OnboardingLinkCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.OnboardingLink>>;
+      }
+    }
+  }
+}