stripe 16.12.0 → 17.0.0

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

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface MeterEventStreamCreateParams {
+          /**
+           * List of meter events to include in the request.
+           */
+          events: Array<MeterEventStreamCreateParams.Event>;
+        }
+
+        namespace MeterEventStreamCreateParams {
+          interface Event {
+            /**
+             * The name of the meter event. Corresponds with the `event_name` field on a meter.
+             */
+            event_name: string;
+
+            /**
+             * A unique identifier for the event. If not provided, one will be generated.
+             * We recommend using a globally unique identifier for this. We'll enforce
+             * uniqueness within a rolling 24 hour period.
+             */
+            identifier?: string;
+
+            /**
+             * The payload of the event. This must contain the fields corresponding to a meter's
+             * `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
+             * `value_settings.event_payload_key` (default is `value`). Read more about
+             * the
+             * [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+             */
+            payload: {
+              [key: string]: string;
+            };
+
+            /**
+             * The time of the event. Must be within the past 35 calendar days or up to
+             * 5 minutes in the future. Defaults to current timestamp if not specified.
+             */
+            timestamp?: string;
+          }
+        }
+      }
+
+      namespace Billing {
+        class MeterEventStreamResource {
+          /**
+           * Creates meter events. Events are processed asynchronously, including validation. Requires a meter event session for authentication. Supports up to 10,000 requests per second in livemode. For even higher rate-limits, contact sales.
+           * @throws Stripe.TemporarySessionExpiredError
+           */
+          create(
+            params: MeterEventStreamCreateParams,
+            options?: RequestOptions
+          ): Promise<void>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * Fix me empty_doc_string.
+         */
+        interface MeterEvent {
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'billing.meter_event';
+
+          /**
+           * The creation time of this meter event.
+           */
+          created: string;
+
+          /**
+           * The name of the meter event. Corresponds with the `event_name` field on a meter.
+           */
+          event_name: string;
+
+          /**
+           * A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.
+           */
+          identifier: 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;
+
+          /**
+           * The payload of the event. This must contain the fields corresponding to a meter's
+           * `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
+           * `value_settings.event_payload_key` (default is `value`). Read more about the payload.
+           */
+          payload: {
+            [key: string]: string;
+          };
+
+          /**
+           * The time of the event. Must be within the past 35 calendar days or up to
+           * 5 minutes in the future. Defaults to current timestamp if not specified.
+           */
+          timestamp: string;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface MeterEventCreateParams {
+          /**
+           * The name of the meter event. Corresponds with the `event_name` field on a meter.
+           */
+          event_name: string;
+
+          /**
+           * The payload of the event. This must contain the fields corresponding to a meter's
+           * `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
+           * `value_settings.event_payload_key` (default is `value`). Read more about
+           * the
+           * [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+           */
+          payload: {
+            [key: string]: string;
+          };
+
+          /**
+           * A unique identifier for the event. If not provided, one will be generated.
+           * We recommend using a globally unique identifier for this. We'll enforce
+           * uniqueness within a rolling 24 hour period.
+           */
+          identifier?: string;
+
+          /**
+           * The time of the event. Must be within the past 35 calendar days or up to
+           * 5 minutes in the future. Defaults to current timestamp if not specified.
+           */
+          timestamp?: string;
+        }
+      }
+
+      namespace Billing {
+        class MeterEventsResource {
+          /**
+           * Creates a meter event. Events are validated synchronously, but are processed asynchronously. Supports up to 1,000 events per second in livemode. For higher rate-limits, please use meter event streams instead.
+           */
+          create(
+            params: MeterEventCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEvent>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/BillingResource.d.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      class BillingResource {
+        meterEventSession: Stripe.V2.Billing.MeterEventSessionResource;
+        meterEventAdjustments: Stripe.V2.Billing.MeterEventAdjustmentsResource;
+        meterEventStream: Stripe.V2.Billing.MeterEventStreamResource;
+        meterEvents: Stripe.V2.Billing.MeterEventsResource;
+      }
+    }
+  }
+}

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

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec
+
+/// <reference path='../EventTypes.d.ts' />
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        interface EventRetrieveParams {}
+      }
+
+      namespace Core {
+        interface EventListParams {
+          /**
+           * Primary object ID used to retrieve related events.
+           */
+          object_id: string;
+
+          /**
+           * The page size.
+           */
+          limit?: number;
+
+          /**
+           * The requested page number.
+           */
+          page?: string;
+        }
+      }
+
+      namespace Core {
+        class EventsResource {
+          /**
+           * Retrieves the details of an event.
+           */
+          retrieve(
+            id: string,
+            params?: EventRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+
+          /**
+           * List events, going back up to 30 days.
+           */
+          list(
+            params: EventListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Event>;
+        }
+      }
+    }
+  }
+}

package/types/V2/CoreResource.d.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      class CoreResource {
+        events: Stripe.V2.Core.EventsResource;
+      }
+    }
+  }
+}

package/types/V2/EventTypes.d.ts

@@ -0,0 +1,214 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe.V2 {
+    export type Event =
+      | Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
+      | Stripe.Events.V1BillingMeterNoMeterFoundEvent;
+  }
+
+  namespace Stripe.Events {
+    /**
+     * This event occurs when there are invalid async usage events for a given meter.
+     */
+    export interface V1BillingMeterErrorReportTriggeredEvent
+      extends V2.EventBase {
+      type: 'v1.billing.meter.error_report_triggered';
+      // Retrieves data specific to this event.
+      data: V1BillingMeterErrorReportTriggeredEvent.Data;
+      // Retrieves the object associated with the event.
+      related_object: Event.RelatedObject;
+    }
+
+    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;
+              }
+            }
+          }
+        }
+      }
+    }
+
+    /**
+     * This event occurs when async usage events have missing or invalid meter ids.
+     */
+    export interface V1BillingMeterNoMeterFoundEvent extends V2.EventBase {
+      type: 'v1.billing.meter.no_meter_found';
+      // Retrieves data specific to this event.
+      data: V1BillingMeterNoMeterFoundEvent.Data;
+    }
+
+    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;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Events.d.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Event {
+        interface Reason {
+          /**
+           * Event reason type.
+           */
+          type: 'request';
+
+          /**
+           * Information on the API request that instigated the event.
+           */
+          request: Reason.Request | null;
+        }
+
+        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;
+          }
+        }
+      }
+
+      /**
+       * The Event object.
+       */
+      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 | null;
+
+        /**
+         * 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 | null;
+
+        /**
+         * The type of the event.
+         */
+        type: string;
+      }
+    }
+  }
+}

package/types/V2Resource.d.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    class V2Resource {
+      billing: Stripe.V2.BillingResource;
+      core: Stripe.V2.CoreResource;
+    }
+  }
+}

package/types/WebhookEndpointsResource.d.ts

@@ -142,7 +142,8 @@ declare module 'stripe' {
         | '2023-08-16'
         | '2023-10-16'
         | '2024-04-10'
-        | '2024-06-20';
+        | '2024-06-20'
+        | '2024-09-30.acacia';
 
       type EnabledEvent =
         | '*'