stripe 22.5.0 → 22.6.0-alpha.2

package/esm/resources/V2/Signals/AccountActivity.d.ts

@@ -0,0 +1,424 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { OtherString } from '../../../shared.js';
+import { RequestOptions, Response } from '../../../lib.js';
+import { DeletedObject } from './../../V2/DeletedObject.js';
+export declare class AccountActivityResource extends StripeResource {
+    /**
+     * Creates a new account activity to report account registration, login, or evaluation follow-up activity.
+     */
+    create(params: V2.Signals.AccountActivityCreateParams, options?: RequestOptions): Promise<Response<AccountActivity>>;
+    /**
+     * Deletes an AccountActivity by its ID.
+     */
+    del(id: string, params?: V2.Signals.AccountActivityDeleteParams, options?: RequestOptions): Promise<Response<DeletedObject>>;
+    /**
+     * Retrieves an AccountActivity by its ID.
+     */
+    retrieve(id: string, params?: V2.Signals.AccountActivityRetrieveParams, options?: RequestOptions): Promise<Response<AccountActivity>>;
+}
+export interface AccountActivity {
+    /**
+     * Unique identifier for the account activity.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.signals.account_activity';
+    /**
+     * The account, customer, or inline account data associated with the activity.
+     */
+    account_details?: AccountActivity.AccountDetails;
+    /**
+     * The account evaluation this activity is associated with, when applicable.
+     */
+    account_evaluation?: string;
+    /**
+     * Timestamp at which the account activity was created.
+     */
+    created: string;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * Details for the login attempt. Present only when type is login_attempt.
+     */
+    login_attempt?: AccountActivity.LoginAttempt;
+    /**
+     * Details for the login decision. Present only when type is login_decision.
+     */
+    login_decision?: AccountActivity.LoginDecision;
+    /**
+     * Timestamp at which the activity occurred. Defaults to the created time if not provided.
+     */
+    occurred_at: string;
+    /**
+     * Details for the registration attempt. Present only when type is registration_attempt.
+     */
+    registration_attempt?: AccountActivity.RegistrationAttempt;
+    /**
+     * Details for the registration decision. Present only when type is registration_decision.
+     */
+    registration_decision?: AccountActivity.RegistrationDecision;
+    /**
+     * The type of activity.
+     */
+    type: AccountActivity.Type;
+}
+export declare namespace AccountActivity {
+    interface AccountDetails {
+        /**
+         * The v2 account ID of the account.
+         */
+        account?: string;
+        /**
+         * The v1 customer ID of the account, for users not yet migrated to v2/accounts.
+         */
+        customer?: string;
+        /**
+         * Inline account data to evaluate without creating a v2 account.
+         */
+        data?: AccountDetails.Data;
+    }
+    interface LoginAttempt {
+        /**
+         * Client details captured for the attempt.
+         */
+        client_details: LoginAttempt.ClientDetails;
+    }
+    interface LoginDecision {
+        /**
+         * The action the merchant took following the evaluation.
+         */
+        status: LoginDecision.Status;
+    }
+    interface RegistrationAttempt {
+        /**
+         * Client details captured for the attempt.
+         */
+        client_details: RegistrationAttempt.ClientDetails;
+    }
+    interface RegistrationDecision {
+        /**
+         * The action the merchant took following the evaluation.
+         */
+        status: RegistrationDecision.Status;
+    }
+    type Type = 'login_attempt' | 'login_decision' | 'registration_attempt' | 'registration_decision' | OtherString;
+    namespace AccountDetails {
+        interface Data {
+            /**
+             * Default account settings.
+             */
+            defaults?: Data.Defaults;
+            /**
+             * Identity data.
+             */
+            identity?: Data.Identity;
+        }
+        namespace Data {
+            interface Defaults {
+                /**
+                 * Account profile data.
+                 */
+                profile: Defaults.Profile;
+            }
+            interface Identity {
+                /**
+                 * Business details for identity data.
+                 */
+                business_details: Identity.BusinessDetails;
+            }
+            namespace Defaults {
+                interface Profile {
+                    /**
+                     * The business URL.
+                     */
+                    business_url: string;
+                    /**
+                     * Doing business as (DBA) name.
+                     */
+                    doing_business_as?: string;
+                    /**
+                     * Description of the account's product or service.
+                     */
+                    product_description?: string;
+                }
+            }
+            namespace Identity {
+                interface BusinessDetails {
+                    /**
+                     * Registered business name.
+                     */
+                    registered_name?: string;
+                }
+            }
+        }
+    }
+    namespace LoginAttempt {
+        interface ClientDetails {
+            /**
+             * Raw client details for the activity, when a Radar session is not available.
+             */
+            data?: ClientDetails.Data;
+            /**
+             * The Radar session ID capturing client details for the activity.
+             */
+            radar_session?: string;
+        }
+        namespace ClientDetails {
+            interface Data {
+                /**
+                 * The IP address associated with the activity.
+                 */
+                ip: string;
+                /**
+                 * The referrer associated with the activity.
+                 */
+                referrer?: string;
+                /**
+                 * The user agent associated with the activity.
+                 */
+                user_agent?: string;
+            }
+        }
+    }
+    namespace LoginDecision {
+        type Status = 'allowed' | 'blocked' | 'restricted';
+    }
+    namespace RegistrationAttempt {
+        interface ClientDetails {
+            /**
+             * Raw client details for the activity, when a Radar session is not available.
+             */
+            data?: ClientDetails.Data;
+            /**
+             * The Radar session ID capturing client details for the activity.
+             */
+            radar_session?: string;
+        }
+        namespace ClientDetails {
+            interface Data {
+                /**
+                 * The IP address associated with the activity.
+                 */
+                ip: string;
+                /**
+                 * The referrer associated with the activity.
+                 */
+                referrer?: string;
+                /**
+                 * The user agent associated with the activity.
+                 */
+                user_agent?: string;
+            }
+        }
+    }
+    namespace RegistrationDecision {
+        type Status = 'allowed' | 'blocked' | 'restricted';
+    }
+}
+export declare namespace V2 {
+    namespace Signals {
+        interface AccountActivityCreateParams {
+            /**
+             * The type of activity.
+             */
+            type: AccountActivityCreateParams.Type;
+            /**
+             * The account, customer, or inline account data associated with the activity.
+             */
+            account_details?: AccountActivityCreateParams.AccountDetails;
+            /**
+             * The account evaluation this activity is associated with, when applicable.
+             */
+            account_evaluation?: string;
+            /**
+             * Details for the login attempt. Provide only when type is login_attempt.
+             */
+            login_attempt?: AccountActivityCreateParams.LoginAttempt;
+            /**
+             * Details for the login decision. Provide only when type is login_decision.
+             */
+            login_decision?: AccountActivityCreateParams.LoginDecision;
+            /**
+             * Timestamp at which the activity occurred. Defaults to the created time if not provided.
+             */
+            occurred_at?: string;
+            /**
+             * Details for the registration attempt. Provide only when type is registration_attempt.
+             */
+            registration_attempt?: AccountActivityCreateParams.RegistrationAttempt;
+            /**
+             * Details for the registration decision. Provide only when type is registration_decision.
+             */
+            registration_decision?: AccountActivityCreateParams.RegistrationDecision;
+        }
+        namespace AccountActivityCreateParams {
+            type Type = 'login_attempt' | 'login_decision' | 'registration_attempt' | 'registration_decision' | OtherString;
+            interface AccountDetails {
+                /**
+                 * The v2 account ID of the account.
+                 */
+                account?: string;
+                /**
+                 * The v1 customer ID of the account, for users not yet migrated to v2/accounts.
+                 */
+                customer?: string;
+                /**
+                 * Inline account data to evaluate without creating a v2 account.
+                 */
+                data?: AccountDetails.Data;
+            }
+            interface LoginAttempt {
+                /**
+                 * Client details captured for the attempt.
+                 */
+                client_details: LoginAttempt.ClientDetails;
+            }
+            interface LoginDecision {
+                /**
+                 * The action the merchant took following the evaluation.
+                 */
+                status: LoginDecision.Status;
+            }
+            interface RegistrationAttempt {
+                /**
+                 * Client details captured for the attempt.
+                 */
+                client_details: RegistrationAttempt.ClientDetails;
+            }
+            interface RegistrationDecision {
+                /**
+                 * The action the merchant took following the evaluation.
+                 */
+                status: RegistrationDecision.Status;
+            }
+            namespace AccountDetails {
+                interface Data {
+                    /**
+                     * Default account settings.
+                     */
+                    defaults?: Data.Defaults;
+                    /**
+                     * Identity data.
+                     */
+                    identity?: Data.Identity;
+                }
+                namespace Data {
+                    interface Defaults {
+                        /**
+                         * Account profile data.
+                         */
+                        profile: Defaults.Profile;
+                    }
+                    interface Identity {
+                        /**
+                         * Business details for identity data.
+                         */
+                        business_details: Identity.BusinessDetails;
+                    }
+                    namespace Defaults {
+                        interface Profile {
+                            /**
+                             * The business URL.
+                             */
+                            business_url: string;
+                            /**
+                             * Doing business as (DBA) name.
+                             */
+                            doing_business_as?: string;
+                            /**
+                             * Description of the account's product or service.
+                             */
+                            product_description?: string;
+                        }
+                    }
+                    namespace Identity {
+                        interface BusinessDetails {
+                            /**
+                             * Registered business name.
+                             */
+                            registered_name?: string;
+                        }
+                    }
+                }
+            }
+            namespace LoginAttempt {
+                interface ClientDetails {
+                    /**
+                     * Raw client details for the activity, when a Radar session is not available.
+                     */
+                    data?: ClientDetails.Data;
+                    /**
+                     * The Radar session ID capturing client details for the activity.
+                     */
+                    radar_session?: string;
+                }
+                namespace ClientDetails {
+                    interface Data {
+                        /**
+                         * The IP address associated with the activity.
+                         */
+                        ip: string;
+                        /**
+                         * The referrer associated with the activity.
+                         */
+                        referrer?: string;
+                        /**
+                         * The user agent associated with the activity.
+                         */
+                        user_agent?: string;
+                    }
+                }
+            }
+            namespace LoginDecision {
+                type Status = 'allowed' | 'blocked' | 'restricted';
+            }
+            namespace RegistrationAttempt {
+                interface ClientDetails {
+                    /**
+                     * Raw client details for the activity, when a Radar session is not available.
+                     */
+                    data?: ClientDetails.Data;
+                    /**
+                     * The Radar session ID capturing client details for the activity.
+                     */
+                    radar_session?: string;
+                }
+                namespace ClientDetails {
+                    interface Data {
+                        /**
+                         * The IP address associated with the activity.
+                         */
+                        ip: string;
+                        /**
+                         * The referrer associated with the activity.
+                         */
+                        referrer?: string;
+                        /**
+                         * The user agent associated with the activity.
+                         */
+                        user_agent?: string;
+                    }
+                }
+            }
+            namespace RegistrationDecision {
+                type Status = 'allowed' | 'blocked' | 'restricted';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Signals {
+        interface AccountActivityRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Signals {
+        interface AccountActivityDeleteParams {
+        }
+    }
+}

package/esm/resources/V2/Signals/AccountActivity.js

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../../StripeResource.js';
+export class AccountActivityResource extends StripeResource {
+    /**
+     * Creates a new account activity to report account registration, login, or evaluation follow-up activity.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/signals/account_activity', params, options);
+    }
+    /**
+     * Deletes an AccountActivity by its ID.
+     */
+    del(id, params, options) {
+        return this._makeRequest('DELETE', `/v2/signals/account_activity/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Retrieves an AccountActivity by its ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/signals/account_activity/${encodeURIComponent(id)}`, params, options);
+    }
+}
+//# sourceMappingURL=AccountActivity.js.map

package/esm/resources/V2/Signals/AccountActivity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountActivity.js","sourceRoot":"","sources":["../../../../src/resources/V2/Signals/AccountActivity.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAK1D,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IACzD;;OAEG;IACH,MAAM,CACJ,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAC9B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,gCAAgC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACxD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,gCAAgC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACxD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}