stripe 22.3.0 → 22.4.0-alpha.2

package/cjs/resources/V2/Core/Health/AlertHistoryEntries.d.ts

@@ -0,0 +1,416 @@
+import { V2Amount } from './../../V2Amounts.js';
+import { Decimal } from '../../../../shared.js';
+export interface AlertHistoryEntry {
+    /**
+     * Unique identifier for the alert history entry.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.core.health.alert_history_entry';
+    /**
+     * Populated when type is api_error.
+     */
+    api_error?: AlertHistoryEntry.ApiError;
+    /**
+     * Populated when type is api_latency.
+     */
+    api_latency?: AlertHistoryEntry.ApiLatency;
+    /**
+     * The time at which this transition occurred.
+     */
+    at: string;
+    /**
+     * Populated when type is authorization_rate_drop.
+     */
+    authorization_rate_drop?: AlertHistoryEntry.AuthorizationRateDrop;
+    /**
+     * Populated when type is elements_error.
+     */
+    elements_error?: AlertHistoryEntry.ElementsError;
+    /**
+     * Populated when type is event_generation_failure.
+     */
+    event_generation_failure?: AlertHistoryEntry.EventGenerationFailure;
+    /**
+     * Populated when type is fraud_rate.
+     */
+    fraud_rate?: AlertHistoryEntry.FraudRate;
+    /**
+     * Populated when type is invoice_count_dropped.
+     */
+    invoice_count_dropped?: AlertHistoryEntry.InvoiceCountDropped;
+    /**
+     * Populated when type is issuing_authorization_request_errors.
+     */
+    issuing_authorization_request_errors?: AlertHistoryEntry.IssuingAuthorizationRequestErrors;
+    /**
+     * Populated when type is issuing_authorization_request_timeout.
+     */
+    issuing_authorization_request_timeout?: AlertHistoryEntry.IssuingAuthorizationRequestTimeout;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * Populated when type is meter_event_summaries_delayed.
+     */
+    meter_event_summaries_delayed?: AlertHistoryEntry.MeterEventSummariesDelayed;
+    /**
+     * Populated when type is metronome_notification_latency.
+     */
+    metronome_notification_latency?: AlertHistoryEntry.MetronomeNotificationLatency;
+    /**
+     * Populated when type is payment_method_error.
+     */
+    payment_method_error?: AlertHistoryEntry.PaymentMethodError;
+    /**
+     * Populated when type is sepa_debit_delayed.
+     */
+    sepa_debit_delayed?: AlertHistoryEntry.SepaDebitDelayed;
+    /**
+     * Populated when type is traffic_volume_drop.
+     */
+    traffic_volume_drop?: AlertHistoryEntry.TrafficVolumeDrop;
+    /**
+     * The type of transition that occurred.
+     */
+    transition: AlertHistoryEntry.Transition;
+    /**
+     * The type of the alert. Determines which sub-hash field is populated.
+     */
+    type: AlertHistoryEntry.Type;
+    /**
+     * Populated when type is webhook_latency.
+     */
+    webhook_latency?: AlertHistoryEntry.WebhookLatency;
+}
+export declare namespace AlertHistoryEntry {
+    interface ApiError {
+        /**
+         * The canonical path.
+         */
+        canonical_path: string;
+        /**
+         * The error code.
+         */
+        error_code?: string;
+        /**
+         * The HTTP method.
+         */
+        http_method: ApiError.HttpMethod;
+        /**
+         * The HTTP status.
+         */
+        http_status: string;
+        /**
+         * The number of impacted requests.
+         */
+        impacted_requests: number;
+        /**
+         * The percentage of impacted requests.
+         */
+        impacted_requests_percentage?: Decimal;
+        /**
+         * The top impacted connected accounts (only for platforms).
+         */
+        top_impacted_accounts?: Array<ApiError.TopImpactedAccount>;
+    }
+    interface ApiLatency {
+        /**
+         * The canonical path.
+         */
+        canonical_path: string;
+        /**
+         * The HTTP method.
+         */
+        http_method: ApiLatency.HttpMethod;
+        /**
+         * The HTTP status.
+         */
+        http_status: string;
+        /**
+         * The number of impacted requests.
+         */
+        impacted_requests: number;
+        /**
+         * The percentage of impacted requests.
+         */
+        impacted_requests_percentage?: Decimal;
+        /**
+         * The top impacted connected accounts (only for platforms).
+         */
+        top_impacted_accounts?: Array<ApiLatency.TopImpactedAccount>;
+    }
+    interface AuthorizationRateDrop {
+        /**
+         * The type of the charge.
+         */
+        charge_type: AuthorizationRateDrop.ChargeType;
+        /**
+         * The current authorization rate percentage.
+         */
+        current_percentage: Decimal;
+        /**
+         * Dimensions that describe what subset of payments are impacted.
+         */
+        dimensions?: Array<AuthorizationRateDrop.Dimension>;
+        /**
+         * The type of the payment method.
+         */
+        payment_method_type: AuthorizationRateDrop.PaymentMethodType;
+        /**
+         * The previous authorization rate percentage.
+         */
+        previous_percentage: Decimal;
+    }
+    interface ElementsError {
+        /**
+         * The type of the element.
+         */
+        element_type?: ElementsError.ElementType;
+        /**
+         * The number of impacted sessions.
+         */
+        impacted_sessions: number;
+    }
+    interface EventGenerationFailure {
+        /**
+         * The context the event should have been generated for. Only present when the account is a connected account.
+         */
+        context?: string;
+        /**
+         * The type of event that Stripe failed to generate.
+         */
+        event_type: string;
+        /**
+         * The related object details.
+         */
+        related_object: EventGenerationFailure.RelatedObject;
+    }
+    interface FraudRate {
+        /**
+         * Fraud attack type.
+         */
+        attack_type: FraudRate.AttackType;
+        /**
+         * The number of impacted requests which are detected.
+         */
+        impacted_requests: number;
+        /**
+         * Estimated aggregated amount for the impacted requests.
+         */
+        realized_fraud_amount: V2Amount;
+    }
+    interface InvoiceCountDropped {
+        /**
+         * The observed number of invoices within the time window.
+         */
+        observed_count: Decimal;
+        /**
+         * The expected threshold number of invoices within the time window.
+         */
+        threshold_count: Decimal;
+        /**
+         * The size of the observation time window.
+         */
+        time_window: string;
+    }
+    interface IssuingAuthorizationRequestErrors {
+        /**
+         * Estimated aggregated amount for the approved requests.
+         */
+        approved_amount?: V2Amount;
+        /**
+         * The number of approved requests which are impacted.
+         */
+        approved_impacted_requests?: number;
+        /**
+         * Estimated aggregated amount for the declined requests.
+         */
+        declined_amount?: V2Amount;
+        /**
+         * The number of declined requests which are impacted.
+         */
+        declined_impacted_requests?: number;
+    }
+    interface IssuingAuthorizationRequestTimeout {
+        /**
+         * Estimated aggregated amount for the approved requests.
+         */
+        approved_amount?: V2Amount;
+        /**
+         * The number of approved requests which are impacted.
+         */
+        approved_impacted_requests?: number;
+        /**
+         * Estimated aggregated amount for the declined requests.
+         */
+        declined_amount?: V2Amount;
+        /**
+         * The number of declined requests which are impacted.
+         */
+        declined_impacted_requests?: number;
+    }
+    interface MeterEventSummariesDelayed {
+        /**
+         * The ingestion method.
+         */
+        ingestion_method?: 'import_sets';
+    }
+    interface MetronomeNotificationLatency {
+        /**
+         * The impacted Metronome billing pipeline.
+         */
+        pipeline: MetronomeNotificationLatency.Pipeline;
+    }
+    interface PaymentMethodError {
+        /**
+         * The returned error code.
+         */
+        error_code?: string;
+        /**
+         * The number of impacted requests.
+         */
+        impacted_requests: number;
+        /**
+         * The percentage of impacted requests.
+         */
+        impacted_requests_percentage?: Decimal;
+        /**
+         * The type of the payment method.
+         */
+        payment_method_type: PaymentMethodError.PaymentMethodType;
+        /**
+         * The top impacted connected accounts (only for platforms).
+         */
+        top_impacted_accounts?: Array<PaymentMethodError.TopImpactedAccount>;
+    }
+    interface SepaDebitDelayed {
+        /**
+         * The number of impacted payments.
+         */
+        impacted_payments: number;
+        /**
+         * The percentage of impacted payments.
+         */
+        impacted_payments_percentage: Decimal;
+    }
+    interface TrafficVolumeDrop {
+        /**
+         * The total volume of payment requests within the latest observation time window.
+         */
+        actual_traffic: number;
+        /**
+         * The canonical path.
+         */
+        canonical_path?: string;
+        /**
+         * The expected volume of payment requests within the latest observation time window.
+         */
+        expected_traffic?: number;
+        /**
+         * The size of the observation time window.
+         */
+        time_window: string;
+    }
+    type Transition = 'impact_updated' | 'opened' | 'resolved';
+    type Type = 'api_error' | 'api_latency' | 'authorization_rate_drop' | 'elements_error' | 'event_generation_failure' | 'fraud_rate' | 'invoice_count_dropped' | 'issuing_authorization_request_errors' | 'issuing_authorization_request_timeout' | 'meter_event_summaries_delayed' | 'metronome_notification_latency' | 'payment_method_error' | 'sepa_debit_delayed' | 'traffic_volume_drop' | 'webhook_latency';
+    interface WebhookLatency {
+        /**
+         * The number of impacted requests.
+         */
+        impacted_requests: number;
+    }
+    namespace ApiError {
+        type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
+        interface TopImpactedAccount {
+            /**
+             * The account ID of the impacted connected account.
+             */
+            account: string;
+            /**
+             * The number of impacted requests.
+             */
+            impacted_requests: number;
+            /**
+             * The percentage of impacted requests.
+             */
+            impacted_requests_percentage?: Decimal;
+        }
+    }
+    namespace ApiLatency {
+        type HttpMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
+        interface TopImpactedAccount {
+            /**
+             * The account ID of the impacted connected account.
+             */
+            account: string;
+            /**
+             * The number of impacted requests.
+             */
+            impacted_requests: number;
+            /**
+             * The percentage of impacted requests.
+             */
+            impacted_requests_percentage?: Decimal;
+        }
+    }
+    namespace AuthorizationRateDrop {
+        type ChargeType = 'money_moving' | 'validation';
+        interface Dimension {
+            /**
+             * Populated when type is issuer.
+             */
+            issuer?: string;
+            /**
+             * The type of the dimension. Determines which field in dimension_details is populated.
+             */
+            type: 'issuer';
+        }
+        type PaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'apple_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cartes_bancaires' | 'cashapp' | 'crypto' | 'dummy_passthrough_card' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kriya' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'mondu' | 'multibanco' | 'naver_pay' | 'ng_bank' | 'ng_bank_transfer' | 'ng_card' | 'ng_market' | 'ng_ussd' | 'ng_wallet' | 'oxxo' | 'p24' | 'paper_check' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pay_by_bank' | 'pix' | 'promptpay' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sequra' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'vipps' | 'wechat_pay' | 'zip';
+    }
+    namespace ElementsError {
+        type ElementType = 'expressCheckout' | 'payment';
+    }
+    namespace EventGenerationFailure {
+        interface RelatedObject {
+            /**
+             * The ID of the related object (e.g., "pi_...").
+             */
+            id: string;
+            /**
+             * The type of the related object (e.g., "payment_intent").
+             */
+            type: string;
+            /**
+             * The API URL for the related object (e.g., "/v1/payment_intents/pi_...").
+             */
+            url: string;
+        }
+    }
+    namespace FraudRate {
+        type AttackType = 'spike' | 'sustained_attack';
+    }
+    namespace MetronomeNotificationLatency {
+        type Pipeline = 'configuration_triggered' | 'high_cardinality_usage_triggered' | 'standard_usage_triggered' | 'time_triggered';
+    }
+    namespace PaymentMethodError {
+        type PaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'apple_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cartes_bancaires' | 'cashapp' | 'crypto' | 'dummy_passthrough_card' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kriya' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'mondu' | 'multibanco' | 'naver_pay' | 'ng_bank' | 'ng_bank_transfer' | 'ng_card' | 'ng_market' | 'ng_ussd' | 'ng_wallet' | 'oxxo' | 'p24' | 'paper_check' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pay_by_bank' | 'pix' | 'promptpay' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sequra' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'vipps' | 'wechat_pay' | 'zip';
+        interface TopImpactedAccount {
+            /**
+             * The account ID of the impacted connected account.
+             */
+            account: string;
+            /**
+             * The number of impacted requests.
+             */
+            impacted_requests: number;
+            /**
+             * The percentage of impacted requests.
+             */
+            impacted_requests_percentage?: Decimal;
+        }
+    }
+}

package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js

@@ -0,0 +1,4 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AlertHistoryEntries.js.map

package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlertHistoryEntries.js","sourceRoot":"","sources":["../../../../../src/resources/V2/Core/Health/AlertHistoryEntries.ts"],"names":[],"mappings":";AAAA,uCAAuC"}

package/cjs/resources/V2/Core/Health/Alerts/History.d.ts

@@ -0,0 +1,23 @@
+import { StripeResource } from '../../../../../StripeResource.js';
+import { AlertHistoryEntry } from './../../../../V2/Core/Health/AlertHistoryEntries.js';
+import { RequestOptions, V2ListPromise } from '../../../../../lib.js';
+export declare class HistoryResource extends StripeResource {
+    /**
+     * Retrieves a list of alert history entries for a health alert.
+     */
+    list(id: string, params?: V2.Core.Health.Alerts.HistoryListParams, options?: RequestOptions): V2ListPromise<AlertHistoryEntry>;
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Health {
+            namespace Alerts {
+                interface HistoryListParams {
+                    /**
+                     * The page limit.
+                     */
+                    limit?: number;
+                }
+            }
+        }
+    }
+}

package/cjs/resources/V2/Core/Health/Alerts/History.js

@@ -0,0 +1,101 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HistoryResource = void 0;
+const StripeResource_js_1 = require("../../../../../StripeResource.js");
+class HistoryResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Retrieves a list of alert history entries for a health alert.
+     */
+    list(id, params, options) {
+        return this._makeRequest('GET', `/v2/core/health/alerts/${encodeURIComponent(id)}/history`, params, options, {
+            methodType: 'list',
+            responseSchema: {
+                kind: 'object',
+                fields: {
+                    data: {
+                        kind: 'array',
+                        element: {
+                            kind: 'object',
+                            fields: {
+                                api_error: {
+                                    kind: 'object',
+                                    fields: {
+                                        impacted_requests_percentage: { kind: 'decimal_string' },
+                                        top_impacted_accounts: {
+                                            kind: 'array',
+                                            element: {
+                                                kind: 'object',
+                                                fields: {
+                                                    impacted_requests_percentage: {
+                                                        kind: 'decimal_string',
+                                                    },
+                                                },
+                                            },
+                                        },
+                                    },
+                                },
+                                api_latency: {
+                                    kind: 'object',
+                                    fields: {
+                                        impacted_requests_percentage: { kind: 'decimal_string' },
+                                        top_impacted_accounts: {
+                                            kind: 'array',
+                                            element: {
+                                                kind: 'object',
+                                                fields: {
+                                                    impacted_requests_percentage: {
+                                                        kind: 'decimal_string',
+                                                    },
+                                                },
+                                            },
+                                        },
+                                    },
+                                },
+                                authorization_rate_drop: {
+                                    kind: 'object',
+                                    fields: {
+                                        current_percentage: { kind: 'decimal_string' },
+                                        previous_percentage: { kind: 'decimal_string' },
+                                    },
+                                },
+                                invoice_count_dropped: {
+                                    kind: 'object',
+                                    fields: {
+                                        observed_count: { kind: 'decimal_string' },
+                                        threshold_count: { kind: 'decimal_string' },
+                                    },
+                                },
+                                payment_method_error: {
+                                    kind: 'object',
+                                    fields: {
+                                        impacted_requests_percentage: { kind: 'decimal_string' },
+                                        top_impacted_accounts: {
+                                            kind: 'array',
+                                            element: {
+                                                kind: 'object',
+                                                fields: {
+                                                    impacted_requests_percentage: {
+                                                        kind: 'decimal_string',
+                                                    },
+                                                },
+                                            },
+                                        },
+                                    },
+                                },
+                                sepa_debit_delayed: {
+                                    kind: 'object',
+                                    fields: {
+                                        impacted_payments_percentage: { kind: 'decimal_string' },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        });
+    }
+}
+exports.HistoryResource = HistoryResource;
+//# sourceMappingURL=History.js.map

package/cjs/resources/V2/Core/Health/Alerts/History.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"History.js","sourceRoot":"","sources":["../../../../../../src/resources/V2/Core/Health/Alerts/History.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,wEAAgE;AAIhE,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,IAAI,CACF,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,0BAA0B,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC1D,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;YAClB,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,SAAS,EAAE;oCACT,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE;wCACN,4BAA4B,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;wCACtD,qBAAqB,EAAE;4CACrB,IAAI,EAAE,OAAO;4CACb,OAAO,EAAE;gDACP,IAAI,EAAE,QAAQ;gDACd,MAAM,EAAE;oDACN,4BAA4B,EAAE;wDAC5B,IAAI,EAAE,gBAAgB;qDACvB;iDACF;6CACF;yCACF;qCACF;iCACF;gCACD,WAAW,EAAE;oCACX,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE;wCACN,4BAA4B,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;wCACtD,qBAAqB,EAAE;4CACrB,IAAI,EAAE,OAAO;4CACb,OAAO,EAAE;gDACP,IAAI,EAAE,QAAQ;gDACd,MAAM,EAAE;oDACN,4BAA4B,EAAE;wDAC5B,IAAI,EAAE,gBAAgB;qDACvB;iDACF;6CACF;yCACF;qCACF;iCACF;gCACD,uBAAuB,EAAE;oCACvB,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE;wCACN,kBAAkB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;wCAC5C,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;qCAC9C;iCACF;gCACD,qBAAqB,EAAE;oCACrB,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE;wCACN,cAAc,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;wCACxC,eAAe,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;qCAC1C;iCACF;gCACD,oBAAoB,EAAE;oCACpB,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE;wCACN,4BAA4B,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;wCACtD,qBAAqB,EAAE;4CACrB,IAAI,EAAE,OAAO;4CACb,OAAO,EAAE;gDACP,IAAI,EAAE,QAAQ;gDACd,MAAM,EAAE;oDACN,4BAA4B,EAAE;wDAC5B,IAAI,EAAE,gBAAgB;qDACvB;iDACF;6CACF;yCACF;qCACF;iCACF;gCACD,kBAAkB,EAAE;oCAClB,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE;wCACN,4BAA4B,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;qCACvD;iCACF;6BACF;yBACF;qBACF;iBACF;aACF;SACF,CACK,CAAC;IACX,CAAC;CACF;AAvGD,0CAuGC"}