@depup/stripe 21.0.0-depup.0

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

@@ -0,0 +1,86 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        namespace Event {
+          type Changes = {
+            [key: string]: unknown;
+          };
+
+          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';
+
+          /**
+           * Before and after changes for the primary related object.
+           */
+          changes?: Event.Changes;
+
+          /**
+           * 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

@@ -0,0 +1,63 @@
+// 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 {
+          /**
+           * Set of filters to query events within a range of `created` timestamps.
+           */
+          created?: Stripe.RangeQueryParam;
+
+          /**
+           * The page size.
+           */
+          limit?: number;
+
+          /**
+           * Primary object ID used to retrieve related events.
+           */
+          object_id?: string;
+
+          /**
+           * An array of up to 20 strings containing specific event names.
+           */
+          types?: Array<string>;
+        }
+      }
+
+      namespace Core {
+        class EventsResource {
+          /**
+           * Retrieves the details of an event.
+           */
+          retrieve(
+            id: string,
+            params?: EventRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Core.Event>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Core.Event>>;
+
+          /**
+           * List events, going back up to 30 days.
+           */
+          list(
+            params?: EventListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Core.Event>;
+          list(options?: RequestOptions): ApiListPromise<Stripe.V2.Core.Event>;
+        }
+      }
+    }
+  }
+}

package/types/V2/DeletedObject.d.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      /**
+       * The DeletedObject object.
+       */
+      interface DeletedObject {
+        /**
+         * The ID of the object that's being deleted.
+         */
+        id: string;
+
+        /**
+         * String representing the type of the object that has been deleted. Objects of the same type share the same value of the object field.
+         */
+        object?: string;
+      }
+    }
+  }
+}

package/types/V2/EventMisc.d.ts

@@ -0,0 +1,80 @@
+declare module 'stripe' {
+  namespace Stripe {
+    class StripeContext {
+      constructor(segments?: string[]);
+
+      /**
+       * Gets a copy of the segments of this Context.
+       */
+      readonly segments: Array<string>;
+
+      /**
+       * Creates a new StripeContext with an additional segment appended.
+       */
+      push(segment: string): StripeContext;
+
+      /**
+       * Creates a new StripeContext with the last segment removed.
+       */
+      pop(): StripeContext;
+
+      /**
+       * Converts this context to its string representation.
+       */
+      toString(): string;
+
+      static parse(contextStr?: string | null): StripeContext;
+    }
+
+    namespace Events {
+      /**
+       * Represents the shape of an EventNotification that the SDK didn't know about when it was generated.
+       */
+      export interface UnknownEventNotification
+        extends V2.Core.EventNotificationBase {
+        /**
+         * Object containing the reference to API resource relevant to the event.
+         */
+        related_object: V2.Core.Events.RelatedObject | null;
+        /**
+         * Fetches the full object corresponding to the `related_object` field.
+         * Returns `null` if there is no `related_object`.
+         */
+        fetchRelatedObject: () => Promise<unknown>;
+        /**
+         * Fetches the full Event object corresponding to this notification.
+         */
+        fetchEvent: () => Promise<V2.Core.EventBase>;
+      }
+    }
+
+    namespace V2.Core {
+      export interface EventNotificationBase
+        extends Omit<EventBase, 'context'> {
+        context?: StripeContext;
+      }
+
+      namespace Events {
+        /**
+         * Object containing the reference to API resource relevant to the event.
+         */
+        export interface RelatedObject {
+          /**
+           * Unique identifier for the object relevant to the event.
+           */
+          id: string;
+
+          /**
+           * Type of the object relevant to the event.
+           */
+          type: string;
+
+          /**
+           * URL to retrieve the resource.
+           */
+          url: string;
+        }
+      }
+    }
+  }
+}

package/types/WebhookEndpoints.d.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The DeletedWebhookEndpoint object.
+     */
+    interface DeletedWebhookEndpoint {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'webhook_endpoint';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+    }
+
+    /**
+     * You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be
+     * notified about events that happen in your Stripe account or connected
+     * accounts.
+     *
+     * Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
+     *
+     * Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)
+     */
+    interface WebhookEndpoint {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'webhook_endpoint';
+
+      /**
+       * The API version events are rendered as for this webhook endpoint.
+       */
+      api_version: string | null;
+
+      /**
+       * The ID of the associated Connect application.
+       */
+      application: string | null;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      /**
+       * An optional description of what the webhook is used for.
+       */
+      description: string | null;
+
+      /**
+       * The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.
+       */
+      enabled_events: Array<string>;
+
+      /**
+       * 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: Stripe.Metadata;
+
+      /**
+       * The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.
+       */
+      secret?: string;
+
+      /**
+       * The status of the webhook. It can be `enabled` or `disabled`.
+       */
+      status: string;
+
+      /**
+       * The URL of the webhook endpoint.
+       */
+      url: string;
+    }
+  }
+}