stripe 22.6.1 → 22.7.0-alpha.2

package/cjs/resources/Radar/BillingEvaluations.d.ts

@@ -0,0 +1,372 @@
+import { StripeResource } from '../../StripeResource.js';
+import { MetadataParam, OtherString, AddressParam, Metadata, Address } from '../../shared.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class BillingEvaluationResource extends StripeResource {
+    /**
+     * Request Stripe Radar's assessment of the non-payment abuse risk of an upcoming charge, before the payment is attempted.
+     */
+    create(params: Radar.BillingEvaluationCreateParams, options?: RequestOptions): Promise<Response<BillingEvaluation>>;
+}
+export interface BillingEvaluation {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'radar.billing_evaluation';
+    /**
+     * Client device metadata attached to this billing evaluation.
+     */
+    client_device_metadata_details?: BillingEvaluation.ClientDeviceMetadataDetails;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created_at: number;
+    /**
+     * Details of the customer this billing evaluation assesses.
+     */
+    customer_details?: BillingEvaluation.CustomerDetails;
+    /**
+     * 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: Metadata | null;
+    /**
+     * Payment details for the upcoming charge this billing evaluation assesses.
+     */
+    payment_details?: BillingEvaluation.PaymentDetails;
+    /**
+     * Stripe Radar's signals for the upcoming charge this billing evaluation assesses.
+     */
+    signals: BillingEvaluation.Signals;
+}
+export declare namespace BillingEvaluation {
+    interface ClientDeviceMetadataDetails {
+        /**
+         * ID for the Radar Session associated with the billing 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 | null;
+    }
+    interface CustomerDetails {
+        /**
+         * The ID of the customer whose upcoming payment was evaluated.
+         */
+        customer: string | null;
+        /**
+         * The ID of the Account representing the customer whose upcoming payment was evaluated.
+         */
+        customer_account: string | null;
+        /**
+         * Attributes of the customer being evaluated. These are populated from the `customer` or `customer_account` object when one was supplied, and from the request otherwise.
+         */
+        data: CustomerDetails.Data | null;
+    }
+    interface PaymentDetails {
+        /**
+         * Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+         */
+        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 | null;
+        /**
+         * Details about the payment's customer presence and type.
+         */
+        money_movement_details: PaymentDetails.MoneyMovementDetails | null;
+        /**
+         * Details about the payment method that will be charged.
+         */
+        payment_method_details: PaymentDetails.PaymentMethodDetails | null;
+        /**
+         * Shipping details for the billing evaluation.
+         */
+        shipping_details: PaymentDetails.ShippingDetails | null;
+        /**
+         * Payment statement descriptor.
+         */
+        statement_descriptor: string | null;
+    }
+    interface Signals {
+        /**
+         * Stripe Radar's assessment of the likelihood that the upcoming charge results in non-payment abuse.
+         */
+        non_payment_abuse: Signals.NonPaymentAbuse | null;
+    }
+    namespace CustomerDetails {
+        interface Data {
+            /**
+             * The customer's email address.
+             */
+            email: string | null;
+            /**
+             * The customer's full name or business name.
+             */
+            name: string | null;
+            /**
+             * The customer's phone number.
+             */
+            phone: string | null;
+        }
+    }
+    namespace PaymentDetails {
+        interface MoneyMovementDetails {
+            /**
+             * Describes card money movement details.
+             */
+            card: MoneyMovementDetails.Card | null;
+            /**
+             * Describes the type of money movement. Currently only `card` is supported.
+             */
+            money_movement_type: 'card';
+        }
+        interface PaymentMethodDetails {
+            /**
+             * Billing information associated with the billing evaluation.
+             */
+            billing_details: PaymentMethodDetails.BillingDetails | null;
+            /**
+             * The payment method that will be charged.
+             */
+            payment_method: string | null;
+        }
+        interface ShippingDetails {
+            /**
+             * Address data.
+             */
+            address: Address;
+            /**
+             * Shipping name.
+             */
+            name: string | null;
+            /**
+             * Shipping phone number.
+             */
+            phone: string | null;
+        }
+        namespace MoneyMovementDetails {
+            interface Card {
+                /**
+                 * Describes the presence of the customer during the payment.
+                 */
+                customer_presence: Card.CustomerPresence | null;
+                /**
+                 * Describes the type of payment.
+                 */
+                payment_type: Card.PaymentType | null;
+            }
+            namespace Card {
+                type CustomerPresence = 'off_session' | 'on_session' | OtherString;
+                type PaymentType = 'one_off' | 'recurring' | 'setup_one_off' | 'setup_recurring' | OtherString;
+            }
+        }
+        namespace PaymentMethodDetails {
+            interface BillingDetails {
+                /**
+                 * Address data.
+                 */
+                address: Address;
+                /**
+                 * Email address.
+                 */
+                email: string | null;
+                /**
+                 * Full name.
+                 */
+                name: string | null;
+                /**
+                 * Billing phone number (including extension).
+                 */
+                phone: string | null;
+            }
+        }
+    }
+    namespace Signals {
+        interface NonPaymentAbuse {
+            /**
+             * The time when this signal was evaluated.
+             */
+            evaluated_at: number;
+            /**
+             * Risk level.
+             */
+            risk_level: NonPaymentAbuse.RiskLevel;
+        }
+        namespace NonPaymentAbuse {
+            type RiskLevel = 'elevated' | 'highest' | 'low' | 'normal' | 'not_assessed' | 'unknown' | OtherString;
+        }
+    }
+}
+export declare namespace Radar {
+    interface BillingEvaluationCreateParams {
+        /**
+         * Details about the customer whose upcoming payment is being evaluated.
+         */
+        customer_details: BillingEvaluationCreateParams.CustomerDetails;
+        /**
+         * Details about the upcoming payment being evaluated.
+         */
+        payment_details: BillingEvaluationCreateParams.PaymentDetails;
+        /**
+         * Details about the client device to associate with the billing evaluation.
+         */
+        client_device_metadata_details?: BillingEvaluationCreateParams.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?: MetadataParam;
+    }
+    namespace BillingEvaluationCreateParams {
+        interface CustomerDetails {
+            /**
+             * The ID of the customer whose upcoming payment is being evaluated.
+             */
+            customer?: string;
+            /**
+             * The ID of the Account representing the customer whose upcoming payment is being evaluated.
+             */
+            customer_account?: string;
+            /**
+             * Attributes of the customer being evaluated. Supply these when the customer isn't represented by a Customer or an Account. If `customer` or `customer_account` is also supplied, the attributes on that object are used and these are ignored.
+             */
+            data?: CustomerDetails.Data;
+        }
+        interface PaymentDetails {
+            /**
+             * The amount that the upcoming payment collects. A positive integer representing how much is charged 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 description of the upcoming payment.
+             */
+            description?: string;
+            /**
+             * Details about how the money for the upcoming payment moves.
+             */
+            money_movement_details?: PaymentDetails.MoneyMovementDetails;
+            /**
+             * Details about the payment method that the upcoming payment is charged to.
+             */
+            payment_method_details: PaymentDetails.PaymentMethodDetails;
+            /**
+             * Shipping details for the goods or services covered by the upcoming payment.
+             */
+            shipping_details?: PaymentDetails.ShippingDetails;
+            /**
+             * The statement descriptor that appears on the customer's statement for the upcoming payment.
+             */
+            statement_descriptor?: string;
+        }
+        interface ClientDeviceMetadataDetails {
+            /**
+             * ID for the Radar Session to associate with the billing 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 about the customer behind the upcoming payment.
+             */
+            radar_session: string;
+        }
+        namespace CustomerDetails {
+            interface Data {
+                /**
+                 * The email address of the customer being evaluated.
+                 */
+                email?: string;
+                /**
+                 * The full name or business name of the customer being evaluated.
+                 */
+                name?: string;
+                /**
+                 * The phone number of the customer being evaluated.
+                 */
+                phone?: string;
+            }
+        }
+        namespace PaymentDetails {
+            interface MoneyMovementDetails {
+                /**
+                 * Describes card money movement details.
+                 */
+                card?: MoneyMovementDetails.Card;
+                /**
+                 * Describes the type of money movement. Currently only `card` is supported.
+                 */
+                money_movement_type: 'card';
+            }
+            interface PaymentMethodDetails {
+                /**
+                 * Billing information associated with the payment method used for the upcoming payment.
+                 */
+                billing_details?: PaymentMethodDetails.BillingDetails;
+                /**
+                 * ID of the payment method that the upcoming payment is charged to.
+                 */
+                payment_method: string;
+            }
+            interface ShippingDetails {
+                /**
+                 * Shipping address.
+                 */
+                address?: AddressParam;
+                /**
+                 * Shipping name.
+                 */
+                name?: string;
+                /**
+                 * Shipping phone number.
+                 */
+                phone?: string;
+            }
+            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' | OtherString;
+                    type PaymentType = 'one_off' | 'recurring' | 'setup_one_off' | 'setup_recurring' | OtherString;
+                }
+            }
+            namespace PaymentMethodDetails {
+                interface BillingDetails {
+                    /**
+                     * Billing address.
+                     */
+                    address?: AddressParam;
+                    /**
+                     * Email address.
+                     */
+                    email?: string;
+                    /**
+                     * Full name.
+                     */
+                    name?: string;
+                    /**
+                     * Billing phone number (including extension).
+                     */
+                    phone?: string;
+                }
+            }
+        }
+    }
+}

package/cjs/resources/Radar/BillingEvaluations.js

@@ -0,0 +1,15 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingEvaluationResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class BillingEvaluationResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Request Stripe Radar's assessment of the non-payment abuse risk of an upcoming charge, before the payment is attempted.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/radar/billing_evaluations', params, options);
+    }
+}
+exports.BillingEvaluationResource = BillingEvaluationResource;
+//# sourceMappingURL=BillingEvaluations.js.map

package/cjs/resources/Radar/BillingEvaluations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BillingEvaluations.js","sourceRoot":"","sources":["../../../src/resources/Radar/BillingEvaluations.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAUvD,MAAa,yBAA0B,SAAQ,kCAAc;IAC3D;;OAEG;IACH,MAAM,CACJ,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,+BAA+B,EAC/B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAfD,8DAeC"}

package/cjs/resources/Radar/CustomerEvaluations.d.ts

@@ -0,0 +1,245 @@
+import { StripeResource } from '../../StripeResource.js';
+import { OtherString } from '../../shared.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class CustomerEvaluationResource extends StripeResource {
+    /**
+     * Retrieves an CustomerEvaluation object.
+     */
+    retrieve(id: string, params?: Radar.CustomerEvaluationRetrieveParams, options?: RequestOptions): Promise<Response<CustomerEvaluation>>;
+    /**
+     * Creates a new CustomerEvaluation object.
+     */
+    create(params: Radar.CustomerEvaluationCreateParams, options?: RequestOptions): Promise<Response<CustomerEvaluation>>;
+    /**
+     * Reports an event on a CustomerEvaluation object.
+     */
+    update(id: string, params?: Radar.CustomerEvaluationUpdateParams, options?: RequestOptions): Promise<Response<CustomerEvaluation>>;
+}
+export interface CustomerEvaluation {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'radar.customer_evaluation';
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created_at: number;
+    /**
+     * The ID of the Customer to associate with this CustomerEvaluation.
+     */
+    customer?: string;
+    /**
+     * The type of evaluation event.
+     */
+    event_type: CustomerEvaluation.EventType;
+    /**
+     * A list of events that have been reported on this customer evaluation.
+     */
+    events: Array<CustomerEvaluation.Event> | 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 hash of signal objects providing Radar's evaluation of the customer.
+     */
+    signals: CustomerEvaluation.Signals | null;
+    /**
+     * The outcome status reported for this evaluation: allowed, restricted, or blocked.
+     */
+    status?: string;
+}
+export declare namespace CustomerEvaluation {
+    type EventType = 'login' | 'registration' | OtherString;
+    interface Event {
+        /**
+         * Data about a failed login event.
+         */
+        login_failed?: Event.LoginFailed;
+        /**
+         * Time at which the event occurred. Measured in seconds since the Unix epoch.
+         */
+        occurred_at: number;
+        /**
+         * Data about a failed registration event.
+         */
+        registration_failed?: Event.RegistrationFailed;
+        /**
+         * The type of event that occurred.
+         */
+        type: string;
+    }
+    interface Signals {
+        account_sharing?: Signals.AccountSharing;
+        multi_accounting?: Signals.MultiAccounting;
+    }
+    namespace Event {
+        interface LoginFailed {
+            /**
+             * The reason why this login failed.
+             */
+            reason: string;
+        }
+        interface RegistrationFailed {
+            /**
+             * The reason why this registration failed.
+             */
+            reason: string;
+        }
+    }
+    namespace Signals {
+        interface AccountSharing {
+            /**
+             * Time at which the signal was evaluated. Measured in seconds since the Unix epoch.
+             */
+            evaluated_at: number;
+            /**
+             * The risk level for this signal.
+             */
+            risk_level?: AccountSharing.RiskLevel;
+            /**
+             * Score for this signal (between 0.0 and 100.0).
+             */
+            score: number;
+        }
+        interface MultiAccounting {
+            /**
+             * Time at which the signal was evaluated. Measured in seconds since the Unix epoch.
+             */
+            evaluated_at: number;
+            /**
+             * The risk level for this signal.
+             */
+            risk_level?: MultiAccounting.RiskLevel;
+            /**
+             * Score for this signal (between 0.0 and 100.0).
+             */
+            score: number;
+        }
+        namespace AccountSharing {
+            type RiskLevel = 'elevated' | 'highest' | 'low' | 'normal' | 'not_assessed' | 'unknown' | OtherString;
+        }
+        namespace MultiAccounting {
+            type RiskLevel = 'elevated' | 'highest' | 'low' | 'normal' | 'not_assessed' | 'unknown' | OtherString;
+        }
+    }
+}
+export declare namespace Radar {
+    interface CustomerEvaluationCreateParams {
+        /**
+         * Array of context entries for the evaluation.
+         */
+        evaluation_context: Array<CustomerEvaluationCreateParams.EvaluationContext>;
+        /**
+         * The type of evaluation event.
+         */
+        event_type: CustomerEvaluationCreateParams.EventType;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+    namespace CustomerEvaluationCreateParams {
+        interface EvaluationContext {
+            /**
+             * Client details context.
+             */
+            client_details?: EvaluationContext.ClientDetails;
+            /**
+             * Customer details context.
+             */
+            customer_details?: EvaluationContext.CustomerDetails;
+            /**
+             * The type of context entry.
+             */
+            type: EvaluationContext.Type;
+        }
+        type EventType = 'login' | 'registration' | OtherString;
+        namespace EvaluationContext {
+            interface ClientDetails {
+                /**
+                 * Raw client metadata fallback in case a Radar Session is unavailable.
+                 */
+                data?: ClientDetails.Data;
+                /**
+                 * ID for the Radar Session. Required unless data is provided.
+                 */
+                radar_session?: string;
+            }
+            interface CustomerDetails {
+                /**
+                 * The ID of an existing Customer.
+                 */
+                customer?: string;
+                /**
+                 * Customer data
+                 */
+                customer_data?: CustomerDetails.CustomerData;
+            }
+            type Type = 'client_details' | 'customer_details' | OtherString;
+            namespace ClientDetails {
+                interface Data {
+                    /**
+                     * The end user's IP address. Used for proxy detection and IP-clustering signals.
+                     */
+                    ip: string;
+                    /**
+                     * The referring URL of the login or registration page.
+                     */
+                    referrer?: string;
+                    /**
+                     * The User-Agent HTTP header.
+                     */
+                    user_agent?: string;
+                }
+            }
+            namespace CustomerDetails {
+                interface CustomerData {
+                    /**
+                     * Customer email
+                     */
+                    email?: string;
+                    /**
+                     * Customer name
+                     */
+                    name?: string;
+                    /**
+                     * Customer phone
+                     */
+                    phone?: string;
+                }
+            }
+        }
+    }
+}
+export declare namespace Radar {
+    interface CustomerEvaluationRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Radar {
+    interface CustomerEvaluationUpdateParams {
+        /**
+         * The ID of a Customer to attach to an entity-less registration evaluation.
+         */
+        customer?: string;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * The outcome status of the evaluation: allowed, restricted, or blocked.
+         */
+        status?: CustomerEvaluationUpdateParams.Status;
+    }
+    namespace CustomerEvaluationUpdateParams {
+        type Status = 'allowed' | 'blocked' | 'restricted' | OtherString;
+    }
+}

package/cjs/resources/Radar/CustomerEvaluations.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerEvaluationResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class CustomerEvaluationResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Retrieves an CustomerEvaluation object.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/radar/customer_evaluations/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Creates a new CustomerEvaluation object.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/radar/customer_evaluations', params, options);
+    }
+    /**
+     * Reports an event on a CustomerEvaluation object.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/radar/customer_evaluations/${encodeURIComponent(id)}/report`, params, options);
+    }
+}
+exports.CustomerEvaluationResource = CustomerEvaluationResource;
+//# sourceMappingURL=CustomerEvaluations.js.map

package/cjs/resources/Radar/CustomerEvaluations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomerEvaluations.js","sourceRoot":"","sources":["../../../src/resources/Radar/CustomerEvaluations.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAIvD,MAAa,0BAA2B,SAAQ,kCAAc;IAC5D;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,kCAAkC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,gCAAgC,EAChC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,kCAAkC,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACjE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA7CD,gEA6CC"}