@depup/stripe 21.0.0-depup.0

package/types/Issuing/PersonalizationDesigns.d.ts

@@ -0,0 +1,142 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      /**
+       * A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
+       */
+      interface PersonalizationDesign {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'issuing.personalization_design';
+
+        /**
+         * The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+         */
+        card_logo: string | Stripe.File | null;
+
+        /**
+         * Hash containing carrier text, for use with physical bundles that support carrier text.
+         */
+        carrier_text: PersonalizationDesign.CarrierText | null;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * 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 lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+         */
+        lookup_key: string | null;
+
+        /**
+         * 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;
+
+        /**
+         * Friendly display name.
+         */
+        name: string | null;
+
+        /**
+         * The physical bundle object belonging to this personalization design.
+         */
+        physical_bundle: string | Stripe.Issuing.PhysicalBundle;
+
+        preferences: PersonalizationDesign.Preferences;
+
+        rejection_reasons: PersonalizationDesign.RejectionReasons;
+
+        /**
+         * Whether this personalization design can be used to create cards.
+         */
+        status: PersonalizationDesign.Status;
+      }
+
+      namespace PersonalizationDesign {
+        interface CarrierText {
+          /**
+           * The footer body text of the carrier letter.
+           */
+          footer_body: string | null;
+
+          /**
+           * The footer title text of the carrier letter.
+           */
+          footer_title: string | null;
+
+          /**
+           * The header body text of the carrier letter.
+           */
+          header_body: string | null;
+
+          /**
+           * The header title text of the carrier letter.
+           */
+          header_title: string | null;
+        }
+
+        interface Preferences {
+          /**
+           * Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+           */
+          is_default: boolean;
+
+          /**
+           * Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.
+           */
+          is_platform_default: boolean | null;
+        }
+
+        interface RejectionReasons {
+          /**
+           * The reason(s) the card logo was rejected.
+           */
+          card_logo: Array<RejectionReasons.CardLogo> | null;
+
+          /**
+           * The reason(s) the carrier text was rejected.
+           */
+          carrier_text: Array<RejectionReasons.CarrierText> | null;
+        }
+
+        namespace RejectionReasons {
+          type CardLogo =
+            | 'geographic_location'
+            | 'inappropriate'
+            | 'network_name'
+            | 'non_binary_image'
+            | 'non_fiat_currency'
+            | 'other'
+            | 'other_entity'
+            | 'promotional_material';
+
+          type CarrierText =
+            | 'geographic_location'
+            | 'inappropriate'
+            | 'network_name'
+            | 'non_fiat_currency'
+            | 'other'
+            | 'other_entity'
+            | 'promotional_material';
+        }
+
+        type Status = 'active' | 'inactive' | 'rejected' | 'review';
+      }
+    }
+  }
+}

package/types/Issuing/PersonalizationDesignsResource.d.ts

@@ -0,0 +1,253 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      interface PersonalizationDesignCreateParams {
+        /**
+         * The physical bundle object belonging to this personalization design.
+         */
+        physical_bundle: string;
+
+        /**
+         * The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+         */
+        card_logo?: string;
+
+        /**
+         * Hash containing carrier text, for use with physical bundles that support carrier text.
+         */
+        carrier_text?: PersonalizationDesignCreateParams.CarrierText;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+         */
+        lookup_key?: 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;
+
+        /**
+         * Friendly display name.
+         */
+        name?: string;
+
+        /**
+         * Information on whether this personalization design is used to create cards when one is not specified.
+         */
+        preferences?: PersonalizationDesignCreateParams.Preferences;
+
+        /**
+         * If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
+         */
+        transfer_lookup_key?: boolean;
+      }
+
+      namespace PersonalizationDesignCreateParams {
+        interface CarrierText {
+          /**
+           * The footer body text of the carrier letter.
+           */
+          footer_body?: Stripe.Emptyable<string>;
+
+          /**
+           * The footer title text of the carrier letter.
+           */
+          footer_title?: Stripe.Emptyable<string>;
+
+          /**
+           * The header body text of the carrier letter.
+           */
+          header_body?: Stripe.Emptyable<string>;
+
+          /**
+           * The header title text of the carrier letter.
+           */
+          header_title?: Stripe.Emptyable<string>;
+        }
+
+        interface Preferences {
+          /**
+           * Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+           */
+          is_default: boolean;
+        }
+      }
+
+      interface PersonalizationDesignRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface PersonalizationDesignUpdateParams {
+        /**
+         * The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+         */
+        card_logo?: Stripe.Emptyable<string>;
+
+        /**
+         * Hash containing carrier text, for use with physical bundles that support carrier text.
+         */
+        carrier_text?: Stripe.Emptyable<
+          PersonalizationDesignUpdateParams.CarrierText
+        >;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+         */
+        lookup_key?: Stripe.Emptyable<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;
+
+        /**
+         * Friendly display name. Providing an empty string will set the field to null.
+         */
+        name?: Stripe.Emptyable<string>;
+
+        /**
+         * The physical bundle object belonging to this personalization design.
+         */
+        physical_bundle?: string;
+
+        /**
+         * Information on whether this personalization design is used to create cards when one is not specified.
+         */
+        preferences?: PersonalizationDesignUpdateParams.Preferences;
+
+        /**
+         * If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
+         */
+        transfer_lookup_key?: boolean;
+      }
+
+      namespace PersonalizationDesignUpdateParams {
+        interface CarrierText {
+          /**
+           * The footer body text of the carrier letter.
+           */
+          footer_body?: Stripe.Emptyable<string>;
+
+          /**
+           * The footer title text of the carrier letter.
+           */
+          footer_title?: Stripe.Emptyable<string>;
+
+          /**
+           * The header body text of the carrier letter.
+           */
+          header_body?: Stripe.Emptyable<string>;
+
+          /**
+           * The header title text of the carrier letter.
+           */
+          header_title?: Stripe.Emptyable<string>;
+        }
+
+        interface Preferences {
+          /**
+           * Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+           */
+          is_default: boolean;
+        }
+      }
+
+      interface PersonalizationDesignListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return personalization designs with the given lookup keys.
+         */
+        lookup_keys?: Array<string>;
+
+        /**
+         * Only return personalization designs with the given preferences.
+         */
+        preferences?: PersonalizationDesignListParams.Preferences;
+
+        /**
+         * Only return personalization designs with the given status.
+         */
+        status?: PersonalizationDesignListParams.Status;
+      }
+
+      namespace PersonalizationDesignListParams {
+        interface Preferences {
+          /**
+           * Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
+           */
+          is_default?: boolean;
+
+          /**
+           * Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
+           */
+          is_platform_default?: boolean;
+        }
+
+        type Status = 'active' | 'inactive' | 'rejected' | 'review';
+      }
+
+      class PersonalizationDesignsResource {
+        /**
+         * Creates a personalization design object.
+         */
+        create(
+          params: PersonalizationDesignCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.PersonalizationDesign>>;
+
+        /**
+         * Retrieves a personalization design object.
+         */
+        retrieve(
+          id: string,
+          params?: PersonalizationDesignRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.PersonalizationDesign>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.PersonalizationDesign>>;
+
+        /**
+         * Updates a card personalization object.
+         */
+        update(
+          id: string,
+          params?: PersonalizationDesignUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.PersonalizationDesign>>;
+
+        /**
+         * Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+         */
+        list(
+          params?: PersonalizationDesignListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.PersonalizationDesign>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.PersonalizationDesign>;
+      }
+    }
+  }
+}

package/types/Issuing/PhysicalBundles.d.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      /**
+       * A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
+       */
+      interface PhysicalBundle {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'issuing.physical_bundle';
+
+        features: PhysicalBundle.Features;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * Friendly display name.
+         */
+        name: string;
+
+        /**
+         * Whether this physical bundle can be used to create cards.
+         */
+        status: PhysicalBundle.Status;
+
+        /**
+         * Whether this physical bundle is a standard Stripe offering or custom-made for you.
+         */
+        type: PhysicalBundle.Type;
+      }
+
+      namespace PhysicalBundle {
+        interface Features {
+          /**
+           * The policy for how to use card logo images in a card design with this physical bundle.
+           */
+          card_logo: Features.CardLogo;
+
+          /**
+           * The policy for how to use carrier letter text in a card design with this physical bundle.
+           */
+          carrier_text: Features.CarrierText;
+
+          /**
+           * The policy for how to use a second line on a card with this physical bundle.
+           */
+          second_line: Features.SecondLine;
+        }
+
+        namespace Features {
+          type CardLogo = 'optional' | 'required' | 'unsupported';
+
+          type CarrierText = 'optional' | 'required' | 'unsupported';
+
+          type SecondLine = 'optional' | 'required' | 'unsupported';
+        }
+
+        type Status = 'active' | 'inactive' | 'review';
+
+        type Type = 'custom' | 'standard';
+      }
+    }
+  }
+}

package/types/Issuing/PhysicalBundlesResource.d.ts

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      interface PhysicalBundleRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface PhysicalBundleListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return physical bundles with the given status.
+         */
+        status?: PhysicalBundleListParams.Status;
+
+        /**
+         * Only return physical bundles with the given type.
+         */
+        type?: PhysicalBundleListParams.Type;
+      }
+
+      namespace PhysicalBundleListParams {
+        type Status = 'active' | 'inactive' | 'review';
+
+        type Type = 'custom' | 'standard';
+      }
+
+      class PhysicalBundlesResource {
+        /**
+         * Retrieves a physical bundle object.
+         */
+        retrieve(
+          id: string,
+          params?: PhysicalBundleRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.PhysicalBundle>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.PhysicalBundle>>;
+
+        /**
+         * Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+         */
+        list(
+          params?: PhysicalBundleListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.PhysicalBundle>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.PhysicalBundle>;
+      }
+    }
+  }
+}