@depup/stripe 21.0.0-depup.0

package/types/Radar/PaymentEvaluationsResource.d.ts

@@ -0,0 +1,208 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      interface PaymentEvaluationCreateParams {
+        /**
+         * Details about the customer associated with the payment evaluation.
+         */
+        customer_details: PaymentEvaluationCreateParams.CustomerDetails;
+
+        /**
+         * Details about the payment.
+         */
+        payment_details: PaymentEvaluationCreateParams.PaymentDetails;
+
+        /**
+         * Details about the Client Device Metadata to associate with the payment evaluation.
+         */
+        client_device_metadata_details?: PaymentEvaluationCreateParams.ClientDeviceMetadataDetails;
+
+        /**
+         * 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;
+      }
+
+      namespace PaymentEvaluationCreateParams {
+        interface ClientDeviceMetadataDetails {
+          /**
+           * ID for the Radar Session to associate with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
+           */
+          radar_session: string;
+        }
+
+        interface CustomerDetails {
+          /**
+           * The ID of the customer associated with the payment evaluation.
+           */
+          customer?: string;
+
+          /**
+           * The ID of the Account representing the customer associated with the payment evaluation.
+           */
+          customer_account?: string;
+
+          /**
+           * The customer's email address.
+           */
+          email?: string;
+
+          /**
+           * The customer's full name or business name.
+           */
+          name?: string;
+
+          /**
+           * The customer's phone number.
+           */
+          phone?: string;
+        }
+
+        interface PaymentDetails {
+          /**
+           * The intended amount to collect with this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency).
+           */
+          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;
+
+          /**
+           * Details about the payment's customer presence and type.
+           */
+          money_movement_details?: PaymentDetails.MoneyMovementDetails;
+
+          /**
+           * Details about the payment method to use for the payment.
+           */
+          payment_method_details: PaymentDetails.PaymentMethodDetails;
+
+          /**
+           * Shipping details for the payment evaluation.
+           */
+          shipping_details?: PaymentDetails.ShippingDetails;
+
+          /**
+           * Payment statement descriptor.
+           */
+          statement_descriptor?: string;
+        }
+
+        namespace PaymentDetails {
+          interface MoneyMovementDetails {
+            /**
+             * Describes card money movement details for the payment evaluation.
+             */
+            card?: MoneyMovementDetails.Card;
+
+            /**
+             * Describes the type of money movement. Currently only `card` is supported.
+             */
+            money_movement_type: 'card';
+          }
+
+          namespace MoneyMovementDetails {
+            interface Card {
+              /**
+               * Describes the presence of the customer during the payment.
+               */
+              customer_presence?: Card.CustomerPresence;
+
+              /**
+               * Describes the type of payment.
+               */
+              payment_type?: Card.PaymentType;
+            }
+
+            namespace Card {
+              type CustomerPresence = 'off_session' | 'on_session';
+
+              type PaymentType =
+                | 'one_off'
+                | 'recurring'
+                | 'setup_one_off'
+                | 'setup_recurring';
+            }
+          }
+
+          interface PaymentMethodDetails {
+            /**
+             * Billing information associated with the payment evaluation.
+             */
+            billing_details?: PaymentMethodDetails.BillingDetails;
+
+            /**
+             * ID of the payment method used in this payment evaluation.
+             */
+            payment_method: string;
+          }
+
+          namespace PaymentMethodDetails {
+            interface BillingDetails {
+              /**
+               * Billing address.
+               */
+              address?: Stripe.AddressParam;
+
+              /**
+               * Email address.
+               */
+              email?: string;
+
+              /**
+               * Full name.
+               */
+              name?: string;
+
+              /**
+               * Billing phone number (including extension).
+               */
+              phone?: string;
+            }
+          }
+
+          interface ShippingDetails {
+            /**
+             * Shipping address.
+             */
+            address?: Stripe.AddressParam;
+
+            /**
+             * Shipping name.
+             */
+            name?: string;
+
+            /**
+             * Shipping phone number.
+             */
+            phone?: string;
+          }
+        }
+      }
+
+      class PaymentEvaluationsResource {
+        /**
+         * Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.
+         */
+        create(
+          params: PaymentEvaluationCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.PaymentEvaluation>>;
+      }
+    }
+  }
+}

package/types/Radar/ValueListItems.d.ts

@@ -0,0 +1,74 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      /**
+       * The DeletedValueListItem object.
+       */
+      interface DeletedValueListItem {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'radar.value_list_item';
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted: true;
+      }
+
+      /**
+       * Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
+       *
+       * Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items)
+       */
+      interface ValueListItem {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'radar.value_list_item';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * The name or email address of the user who added this item to the value list.
+         */
+        created_by: string;
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted?: void;
+
+        /**
+         * 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 value of the item.
+         */
+        value: string;
+
+        /**
+         * The identifier of the value list this item belongs to.
+         */
+        value_list: string;
+      }
+    }
+  }
+}

package/types/Radar/ValueListItemsResource.d.ts

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      interface ValueListItemCreateParams {
+        /**
+         * The value of the item (whose type must match the type of the parent value list).
+         */
+        value: string;
+
+        /**
+         * The identifier of the value list which the created item will be added to.
+         */
+        value_list: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ValueListItemRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ValueListItemListParams extends PaginationParams {
+        /**
+         * Identifier for the parent value list this item belongs to.
+         */
+        value_list: string;
+
+        /**
+         * Only return items that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
+         */
+        value?: string;
+      }
+
+      interface ValueListItemDeleteParams {}
+
+      class ValueListItemsResource {
+        /**
+         * Creates a new ValueListItem object, which is added to the specified parent value list.
+         */
+        create(
+          params: ValueListItemCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueListItem>>;
+
+        /**
+         * Retrieves a ValueListItem object.
+         */
+        retrieve(
+          id: string,
+          params?: ValueListItemRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueListItem>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueListItem>>;
+
+        /**
+         * Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+         */
+        list(
+          params: ValueListItemListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Radar.ValueListItem>;
+
+        /**
+         * Deletes a ValueListItem object, removing it from its parent value list.
+         */
+        del(
+          id: string,
+          params?: ValueListItemDeleteParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.DeletedValueListItem>>;
+        del(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.DeletedValueListItem>>;
+      }
+    }
+  }
+}

package/types/Radar/ValueLists.d.ts

@@ -0,0 +1,104 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      /**
+       * The DeletedValueList object.
+       */
+      interface DeletedValueList {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'radar.value_list';
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted: true;
+      }
+
+      /**
+       * Value lists allow you to group values together which can then be referenced in rules.
+       *
+       * Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items)
+       */
+      interface ValueList {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'radar.value_list';
+
+        /**
+         * The name of the value list for use in rules.
+         */
+        alias: string;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * The name or email address of the user who created this value list.
+         */
+        created_by: string;
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted?: void;
+
+        /**
+         * The type of items in the value list. One of `card_fingerprint`, `card_bin`, `crypto_fingerprint`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`.
+         */
+        item_type: ValueList.ItemType;
+
+        /**
+         * List of items contained within this value list.
+         */
+        list_items: ApiList<Stripe.Radar.ValueListItem>;
+
+        /**
+         * 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 name of the value list.
+         */
+        name: string;
+      }
+
+      namespace ValueList {
+        type ItemType =
+          | 'card_bin'
+          | 'card_fingerprint'
+          | 'case_sensitive_string'
+          | 'country'
+          | 'crypto_fingerprint'
+          | 'customer_id'
+          | 'email'
+          | 'ip_address'
+          | 'sepa_debit_fingerprint'
+          | 'string'
+          | 'us_bank_account_fingerprint';
+      }
+    }
+  }
+}

package/types/Radar/ValueListsResource.d.ts

@@ -0,0 +1,156 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      interface ValueListCreateParams {
+        /**
+         * The name of the value list for use in rules.
+         */
+        alias: string;
+
+        /**
+         * The human-readable name of the value list.
+         */
+        name: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `crypto_fingerprint`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed.
+         */
+        item_type?: ValueListCreateParams.ItemType;
+
+        /**
+         * 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;
+      }
+
+      namespace ValueListCreateParams {
+        type ItemType =
+          | 'card_bin'
+          | 'card_fingerprint'
+          | 'case_sensitive_string'
+          | 'country'
+          | 'crypto_fingerprint'
+          | 'customer_id'
+          | 'email'
+          | 'ip_address'
+          | 'sepa_debit_fingerprint'
+          | 'string'
+          | 'us_bank_account_fingerprint';
+      }
+
+      interface ValueListRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ValueListUpdateParams {
+        /**
+         * The name of the value list for use in rules.
+         */
+        alias?: 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.MetadataParam;
+
+        /**
+         * The human-readable name of the value list.
+         */
+        name?: string;
+      }
+
+      interface ValueListListParams extends PaginationParams {
+        /**
+         * The alias used to reference the value list when writing rules.
+         */
+        alias?: string;
+
+        /**
+         * A value contained within a value list - returns all value lists containing this value.
+         */
+        contains?: string;
+
+        /**
+         * Only return value lists 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 ValueListDeleteParams {}
+
+      class ValueListsResource {
+        /**
+         * Creates a new ValueList object, which can then be referenced in rules.
+         */
+        create(
+          params: ValueListCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueList>>;
+
+        /**
+         * Retrieves a ValueList object.
+         */
+        retrieve(
+          id: string,
+          params?: ValueListRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueList>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueList>>;
+
+        /**
+         * Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
+         */
+        update(
+          id: string,
+          params?: ValueListUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.ValueList>>;
+
+        /**
+         * Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+         */
+        list(
+          params?: ValueListListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Radar.ValueList>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Radar.ValueList>;
+
+        /**
+         * Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
+         */
+        del(
+          id: string,
+          params?: ValueListDeleteParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.DeletedValueList>>;
+        del(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.DeletedValueList>>;
+      }
+    }
+  }
+}