stripe 18.6.0-beta.1 → 19.0.0

package/types/Treasury/ReceivedDebits.d.ts

@@ -66,11 +66,6 @@ declare module 'stripe' {
          */
         network: ReceivedDebit.Network;
 
-        /**
-         * Details specific to the money movement rails.
-         */
-        network_details?: ReceivedDebit.NetworkDetails | null;
-
         /**
          * Details describing when a ReceivedDebit might be reversed.
          */
@@ -195,36 +190,10 @@ declare module 'stripe' {
            * Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
            */
           payout: string | null;
-
-          /**
-           * The ReceivedCredit that Capital withheld from
-           */
-          received_credit_capital_withholding?: string | null;
         }
 
         type Network = 'ach' | 'card' | 'stripe';
 
-        interface NetworkDetails {
-          /**
-           * Details about an ACH transaction.
-           */
-          ach?: NetworkDetails.Ach | null;
-
-          /**
-           * The type of flow that originated the ReceivedDebit.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * ACH Addenda record
-             */
-            addenda: string | null;
-          }
-        }
-
         interface ReversalDetails {
           /**
            * Time before which a ReceivedDebit can be reversed.

package/types/V2/Billing/MeterEventStreamResource.d.ts

@@ -6,7 +6,7 @@ declare module 'stripe' {
       namespace Billing {
         interface MeterEventStreamCreateParams {
           /**
-           * List of meter events to include in the request.
+           * List of meter events to include in the request. Supports up to 100 events per request.
            */
           events: Array<MeterEventStreamCreateParams.Event>;
         }

package/types/V2/Core/EventDestinations.d.ts

@@ -0,0 +1,166 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        /**
+         * Set up an event destination to receive events from Stripe across multiple destination types, including [webhook endpoints](https://docs.stripe.com/webhooks) and [Amazon EventBridge](https://docs.stripe.com/event-destinations/eventbridge). Event destinations support receiving [thin events](https://docs.stripe.com/api/v2/events) and [snapshot events](https://docs.stripe.com/api/events).
+         */
+        interface EventDestination {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.core.event_destination';
+
+          /**
+           * Amazon EventBridge configuration.
+           */
+          amazon_eventbridge?: EventDestination.AmazonEventbridge;
+
+          /**
+           * Time at which the object was created.
+           */
+          created: string;
+
+          /**
+           * An optional description of what the event destination is used for.
+           */
+          description: string;
+
+          /**
+           * The list of events to enable for this endpoint.
+           */
+          enabled_events: Array<string>;
+
+          /**
+           * Payload type of events being subscribed to.
+           */
+          event_payload: EventDestination.EventPayload;
+
+          /**
+           * Where events should be routed from.
+           */
+          events_from?: Array<EventDestination.EventsFrom>;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * Metadata.
+           */
+          metadata?: Stripe.Metadata;
+
+          /**
+           * Event destination name.
+           */
+          name: string;
+
+          /**
+           * If using the snapshot event payload, the API version events are rendered as.
+           */
+          snapshot_api_version?: string;
+
+          /**
+           * Status. It can be set to either enabled or disabled.
+           */
+          status: EventDestination.Status;
+
+          /**
+           * Additional information about event destination status.
+           */
+          status_details?: EventDestination.StatusDetails;
+
+          /**
+           * Event destination type.
+           */
+          type: EventDestination.Type;
+
+          /**
+           * Time at which the object was last updated.
+           */
+          updated: string;
+
+          /**
+           * Webhook endpoint configuration.
+           */
+          webhook_endpoint?: EventDestination.WebhookEndpoint;
+        }
+
+        namespace EventDestination {
+          interface AmazonEventbridge {
+            /**
+             * The AWS account ID.
+             */
+            aws_account_id: string;
+
+            /**
+             * The ARN of the AWS event source.
+             */
+            aws_event_source_arn: string;
+
+            /**
+             * The state of the AWS event source.
+             */
+            aws_event_source_status: AmazonEventbridge.AwsEventSourceStatus;
+          }
+
+          namespace AmazonEventbridge {
+            type AwsEventSourceStatus =
+              | 'active'
+              | 'deleted'
+              | 'pending'
+              | 'unknown';
+          }
+
+          type EventPayload = 'snapshot' | 'thin';
+
+          type EventsFrom = 'other_accounts' | 'self';
+
+          type Status = 'disabled' | 'enabled';
+
+          interface StatusDetails {
+            /**
+             * Details about why the event destination has been disabled.
+             */
+            disabled?: StatusDetails.Disabled;
+          }
+
+          namespace StatusDetails {
+            interface Disabled {
+              /**
+               * Reason event destination has been disabled.
+               */
+              reason: Disabled.Reason;
+            }
+
+            namespace Disabled {
+              type Reason = 'no_aws_event_source_exists' | 'user';
+            }
+          }
+
+          type Type = 'amazon_eventbridge' | 'webhook_endpoint';
+
+          interface WebhookEndpoint {
+            /**
+             * The signing secret of the webhook endpoint, only includable on creation.
+             */
+            signing_secret?: string;
+
+            /**
+             * The URL of the webhook endpoint, includable.
+             */
+            url?: string;
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Core/EventDestinationsResource.d.ts

@@ -183,7 +183,7 @@ declare module 'stripe' {
           create(
             params: EventDestinationCreateParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
 
           /**
            * Retrieves the details of an event destination.
@@ -192,11 +192,11 @@ declare module 'stripe' {
             id: string,
             params?: EventDestinationRetrieveParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
           retrieve(
             id: string,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
 
           /**
            * Update the details of an event destination.
@@ -205,7 +205,7 @@ declare module 'stripe' {
             id: string,
             params?: EventDestinationUpdateParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
 
           /**
            * Lists all event destinations.
@@ -213,10 +213,10 @@ declare module 'stripe' {
           list(
             params?: EventDestinationListParams,
             options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.EventDestination>;
+          ): ApiListPromise<Stripe.V2.Core.EventDestination>;
           list(
             options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.EventDestination>;
+          ): ApiListPromise<Stripe.V2.Core.EventDestination>;
 
           /**
            * Delete an event destination.
@@ -225,11 +225,11 @@ declare module 'stripe' {
             id: string,
             params?: EventDestinationDeleteParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
           del(
             id: string,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.DeletedObject>>;
 
           /**
            * Disable an event destination.
@@ -238,11 +238,11 @@ declare module 'stripe' {
             id: string,
             params?: EventDestinationDisableParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
           disable(
             id: string,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
 
           /**
            * Enable an event destination.
@@ -251,11 +251,11 @@ declare module 'stripe' {
             id: string,
             params?: EventDestinationEnableParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
           enable(
             id: string,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.EventDestination>>;
 
           /**
            * Send a `ping` event to an event destination.
@@ -264,11 +264,11 @@ declare module 'stripe' {
             id: string,
             params?: EventDestinationPingParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.Event>>;
           ping(
             id: string,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.Event>>;
         }
       }
     }

package/types/V2/Core/EventTypes.d.ts

@@ -0,0 +1,256 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe.V2.Core {
+    export type Event =
+      | Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
+      | Stripe.Events.V1BillingMeterNoMeterFoundEvent
+      | Stripe.Events.V2CoreEventDestinationPingEvent;
+
+    export type EventNotification =
+      | Stripe.Events.V1BillingMeterErrorReportTriggeredEventNotification
+      | Stripe.Events.V1BillingMeterNoMeterFoundEventNotification
+      | Stripe.Events.V2CoreEventDestinationPingEventNotification;
+  }
+
+  namespace Stripe.Events {
+    /**
+     * Occurs when a Meter has invalid async usage events.
+     */
+    export interface V1BillingMeterErrorReportTriggeredEvent
+      extends V2.Core.EventBase {
+      type: 'v1.billing.meter.error_report_triggered';
+      // Retrieves data specific to this event.
+      data: V1BillingMeterErrorReportTriggeredEvent.Data;
+      // Object containing the reference to API resource relevant to the event.
+      related_object: V2.Core.Events.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<Billing.Meter>;
+    }
+    export interface V1BillingMeterErrorReportTriggeredEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v1.billing.meter.error_report_triggered';
+      // Object containing the reference to API resource relevant to the event.
+      related_object: V2.Core.Events.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<Billing.Meter>;
+      fetchEvent(): Promise<V1BillingMeterErrorReportTriggeredEvent>;
+    }
+
+    namespace V1BillingMeterErrorReportTriggeredEvent {
+      export interface Data {
+        /**
+         * Extra field included in the event's `data` when fetched from /v2/events.
+         */
+        developer_message_summary: string;
+
+        /**
+         * This contains information about why meter error happens.
+         */
+        reason: Data.Reason;
+
+        /**
+         * The end of the window that is encapsulated by this summary.
+         */
+        validation_end: string;
+
+        /**
+         * The start of the window that is encapsulated by this summary.
+         */
+        validation_start: string;
+      }
+
+      namespace Data {
+        export interface Reason {
+          /**
+           * The total error count within this window.
+           */
+          error_count: number;
+
+          /**
+           * The error details.
+           */
+          error_types: Array<Reason.ErrorType>;
+        }
+
+        namespace Reason {
+          export interface ErrorType {
+            /**
+             * Open Enum.
+             */
+            code: ErrorType.Code;
+
+            /**
+             * The number of errors of this type.
+             */
+            error_count: number;
+
+            /**
+             * A list of sample errors of this type.
+             */
+            sample_errors: Array<ErrorType.SampleError>;
+          }
+
+          namespace ErrorType {
+            export type Code =
+              | 'archived_meter'
+              | 'meter_event_customer_not_found'
+              | 'meter_event_dimension_count_too_high'
+              | 'meter_event_invalid_value'
+              | 'meter_event_no_customer_defined'
+              | 'missing_dimension_payload_keys'
+              | 'no_meter'
+              | 'timestamp_in_future'
+              | 'timestamp_too_far_in_past';
+
+            export interface SampleError {
+              /**
+               * The error message.
+               */
+              error_message: string;
+
+              /**
+               * The request causes the error.
+               */
+              request: SampleError.Request;
+            }
+
+            namespace SampleError {
+              export interface Request {
+                /**
+                 * The request idempotency key.
+                 */
+                identifier: string;
+              }
+            }
+          }
+        }
+      }
+    }
+
+    /**
+     * Occurs when a Meter's id is missing or invalid in async usage events.
+     */
+    export interface V1BillingMeterNoMeterFoundEvent extends V2.Core.EventBase {
+      type: 'v1.billing.meter.no_meter_found';
+      // Retrieves data specific to this event.
+      data: V1BillingMeterNoMeterFoundEvent.Data;
+    }
+    export interface V1BillingMeterNoMeterFoundEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v1.billing.meter.no_meter_found';
+      fetchEvent(): Promise<V1BillingMeterNoMeterFoundEvent>;
+    }
+
+    namespace V1BillingMeterNoMeterFoundEvent {
+      export interface Data {
+        /**
+         * Extra field included in the event's `data` when fetched from /v2/events.
+         */
+        developer_message_summary: string;
+
+        /**
+         * This contains information about why meter error happens.
+         */
+        reason: Data.Reason;
+
+        /**
+         * The end of the window that is encapsulated by this summary.
+         */
+        validation_end: string;
+
+        /**
+         * The start of the window that is encapsulated by this summary.
+         */
+        validation_start: string;
+      }
+
+      namespace Data {
+        export interface Reason {
+          /**
+           * The total error count within this window.
+           */
+          error_count: number;
+
+          /**
+           * The error details.
+           */
+          error_types: Array<Reason.ErrorType>;
+        }
+
+        namespace Reason {
+          export interface ErrorType {
+            /**
+             * Open Enum.
+             */
+            code: ErrorType.Code;
+
+            /**
+             * The number of errors of this type.
+             */
+            error_count: number;
+
+            /**
+             * A list of sample errors of this type.
+             */
+            sample_errors: Array<ErrorType.SampleError>;
+          }
+
+          namespace ErrorType {
+            export type Code =
+              | 'archived_meter'
+              | 'meter_event_customer_not_found'
+              | 'meter_event_dimension_count_too_high'
+              | 'meter_event_invalid_value'
+              | 'meter_event_no_customer_defined'
+              | 'missing_dimension_payload_keys'
+              | 'no_meter'
+              | 'timestamp_in_future'
+              | 'timestamp_too_far_in_past';
+
+            export interface SampleError {
+              /**
+               * The error message.
+               */
+              error_message: string;
+
+              /**
+               * The request causes the error.
+               */
+              request: SampleError.Request;
+            }
+
+            namespace SampleError {
+              export interface Request {
+                /**
+                 * The request idempotency key.
+                 */
+                identifier: string;
+              }
+            }
+          }
+        }
+      }
+    }
+
+    /**
+     * A ping event used to test the connection to an EventDestination.
+     */
+    export interface V2CoreEventDestinationPingEvent extends V2.Core.EventBase {
+      type: 'v2.core.event_destination.ping';
+      // Object containing the reference to API resource relevant to the event.
+      related_object: V2.Core.Events.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<V2.Core.EventDestination>;
+    }
+    export interface V2CoreEventDestinationPingEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.core.event_destination.ping';
+      // Object containing the reference to API resource relevant to the event.
+      related_object: V2.Core.Events.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<V2.Core.EventDestination>;
+      fetchEvent(): Promise<V2CoreEventDestinationPingEvent>;
+    }
+  }
+}

package/types/V2/Core/Events.d.ts

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        namespace Event {
+          interface Reason {
+            /**
+             * Event reason type.
+             */
+            type: 'request';
+
+            /**
+             * Information on the API request that instigated the event.
+             */
+            request?: Reason.Request;
+          }
+
+          namespace Reason {
+            interface Request {
+              /**
+               * ID of the API request that caused the event.
+               */
+              id: string;
+
+              /**
+               * The idempotency key transmitted during the request.
+               */
+              idempotency_key: string;
+            }
+          }
+        }
+
+        /**
+         * Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](https://docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](https://docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](https://docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.
+         */
+        interface EventBase {
+          /**
+           * Unique identifier for the event.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.core.event';
+
+          /**
+           * Authentication context needed to fetch the event or related object.
+           */
+          context?: string;
+
+          /**
+           * Time at which the object 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;
+
+          /**
+           * Reason for the event.
+           */
+          reason?: Event.Reason;
+
+          /**
+           * The type of the event.
+           */
+          type: string;
+        }
+      }
+    }
+  }
+}

package/types/V2/Core/EventsResource.d.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec
 
-/// <reference path='../EventTypes.d.ts' />
+/// <reference path='EventTypes.d.ts' />
 
 declare module 'stripe' {
   namespace Stripe {
@@ -32,11 +32,11 @@ declare module 'stripe' {
             id: string,
             params?: EventRetrieveParams,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.Event>>;
           retrieve(
             id: string,
             options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+          ): Promise<Stripe.Response<Stripe.V2.Core.Event>>;
 
           /**
            * List events, going back up to 30 days.
@@ -44,7 +44,7 @@ declare module 'stripe' {
           list(
             params: EventListParams,
             options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.Event>;
+          ): ApiListPromise<Stripe.V2.Core.Event>;
         }
       }
     }