stripe 16.13.0-beta.1 → 17.0.0

package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts

@@ -39,11 +39,6 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedCreditCreateParams.InitiatingPaymentMethodDetails;
-
-          /**
-           * Details about the network used for the ReceivedCredit.
-           */
-          network_details?: ReceivedCreditCreateParams.NetworkDetails;
         }
 
         namespace ReceivedCreditCreateParams {
@@ -79,27 +74,6 @@ declare module 'stripe' {
           }
 
           type Network = 'ach' | 'us_domestic_wire';
-
-          interface NetworkDetails {
-            /**
-             * Optional fields for `ach`.
-             */
-            ach?: NetworkDetails.Ach;
-
-            /**
-             * The type of flow that originated the ReceivedCredit.
-             */
-            type: 'ach';
-          }
-
-          namespace NetworkDetails {
-            interface Ach {
-              /**
-               * ACH Addenda record
-               */
-              addenda?: string;
-            }
-          }
         }
       }
 

package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts

@@ -39,11 +39,6 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedDebitCreateParams.InitiatingPaymentMethodDetails;
-
-          /**
-           * Details about the network used for the ReceivedDebit.
-           */
-          network_details?: ReceivedDebitCreateParams.NetworkDetails;
         }
 
         namespace ReceivedDebitCreateParams {
@@ -77,27 +72,6 @@ declare module 'stripe' {
               routing_number?: string;
             }
           }
-
-          interface NetworkDetails {
-            /**
-             * Optional fields for `ach`.
-             */
-            ach?: NetworkDetails.Ach;
-
-            /**
-             * The type of flow that originated the ReceivedDebit.
-             */
-            type: 'ach';
-          }
-
-          namespace NetworkDetails {
-            interface Ach {
-              /**
-               * Addenda record data associated with this ReceivedDebit.
-               */
-              addenda?: string;
-            }
-          }
         }
       }
 

package/types/ThinEvent.d.ts

@@ -0,0 +1,36 @@
+// This is a manually maintained file
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Event {
+      /**
+       * Object containing the reference to API resource relevant to the event.
+       */
+      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;
+      }
+    }
+    /**
+     * The Event object as recieved from StripeClient.parseThinEvent.
+     */
+    interface ThinEvent extends V2.EventBase {
+      /**
+       * Object containing the reference to API resource relevant to the event.
+       */
+      related_object: Event.RelatedObject | null;
+    }
+  }
+}

package/types/Treasury/FinancialAccounts.d.ts

@@ -38,11 +38,6 @@ declare module 'stripe' {
          */
         created: number;
 
-        /**
-         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
-         */
-        display_name?: string | null;
-
         /**
          * Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
          * Stripe or the platform can control Features via the requested field.

package/types/Treasury/FinancialAccountsResource.d.ts

@@ -9,11 +9,6 @@ declare module 'stripe' {
          */
         supported_currencies: Array<string>;
 
-        /**
-         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
-         */
-        display_name?: Stripe.Emptyable<string>;
-
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -211,11 +206,6 @@ declare module 'stripe' {
       }
 
       interface FinancialAccountUpdateParams {
-        /**
-         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
-         */
-        display_name?: Stripe.Emptyable<string>;
-
         /**
          * Specifies which fields in the response should be expanded.
          */

package/types/Treasury/OutboundTransfers.d.ts

@@ -78,11 +78,6 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata;
 
-        /**
-         * Details about the network used for the OutboundTransfer.
-         */
-        network_details?: OutboundTransfer.NetworkDetails | null;
-
         /**
          * Details about a returned OutboundTransfer. Only set when the status is `returned`.
          */
@@ -189,27 +184,6 @@ declare module 'stripe' {
           }
         }
 
-        interface NetworkDetails {
-          /**
-           * Details about an ACH transaction.
-           */
-          ach?: NetworkDetails.Ach | null;
-
-          /**
-           * The type of flow that originated the OutboundTransfer.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * ACH Addenda record
-             */
-            addenda: string | null;
-          }
-        }
-
         interface ReturnedDetails {
           /**
            * Reason for the return.

package/types/Treasury/OutboundTransfersResource.d.ts

@@ -44,11 +44,6 @@ declare module 'stripe' {
          */
         metadata?: Stripe.MetadataParam;
 
-        /**
-         * Details about the network used for the OutboundTransfer.
-         */
-        network_details?: OutboundTransferCreateParams.NetworkDetails;
-
         /**
          * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
          */
@@ -77,27 +72,6 @@ declare module 'stripe' {
             type Network = 'ach' | 'us_domestic_wire';
           }
         }
-
-        interface NetworkDetails {
-          /**
-           * Optional fields for `ach`.
-           */
-          ach?: NetworkDetails.Ach;
-
-          /**
-           * The type of flow that originated the OutboundTransfer.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * Addenda record data associated with this OutboundTransfer.
-             */
-            addenda?: string;
-          }
-        }
       }
 
       interface OutboundTransferRetrieveParams {

package/types/Treasury/ReceivedCredits.d.ts

@@ -66,11 +66,6 @@ declare module 'stripe' {
          */
         network: ReceivedCredit.Network;
 
-        /**
-         * Details specific to the money movement rails.
-         */
-        network_details?: ReceivedCredit.NetworkDetails | null;
-
         /**
          * Details describing when a ReceivedCredit may be reversed.
          */
@@ -88,7 +83,11 @@ declare module 'stripe' {
       }
 
       namespace ReceivedCredit {
-        type FailureCode = 'account_closed' | 'account_frozen' | 'other';
+        type FailureCode =
+          | 'account_closed'
+          | 'account_frozen'
+          | 'international_transaction'
+          | 'other';
 
         interface InitiatingPaymentMethodDetails {
           /**
@@ -242,27 +241,6 @@ declare module 'stripe' {
 
         type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
 
-        interface NetworkDetails {
-          /**
-           * Details about an ACH transaction.
-           */
-          ach?: NetworkDetails.Ach | null;
-
-          /**
-           * The type of flow that originated the ReceivedCredit.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * ACH Addenda record
-             */
-            addenda: string | null;
-          }
-        }
-
         interface ReversalDetails {
           /**
            * Time before which a ReceivedCredit can be reversed.

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/MeterEventAdjustments.d.ts

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The MeterEventAdjustment object.
+         */
+        interface MeterEventAdjustment {
+          /**
+           * The unique id of this meter event adjustment.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'billing.meter_event_adjustment';
+
+          /**
+           * Specifies which event to cancel.
+           */
+          cancel: MeterEventAdjustment.Cancel;
+
+          /**
+           * The time the adjustment was created.
+           */
+          created: string;
+
+          /**
+           * The name of the meter event. Corresponds with the `event_name` field on a meter.
+           */
+          event_name: 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;
+
+          /**
+           * Open Enum. The meter event adjustment's status.
+           */
+          status: MeterEventAdjustment.Status;
+
+          /**
+           * Open Enum. Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+           */
+          type: 'cancel';
+        }
+
+        namespace MeterEventAdjustment {
+          interface Cancel {
+            /**
+             * Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+             */
+            identifier: string;
+          }
+
+          type Status = 'complete' | 'pending';
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface MeterEventAdjustmentCreateParams {
+          /**
+           * Specifies which event to cancel.
+           */
+          cancel: MeterEventAdjustmentCreateParams.Cancel;
+
+          /**
+           * The name of the meter event. Corresponds with the `event_name` field on a meter.
+           */
+          event_name: string;
+
+          /**
+           * Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+           */
+          type: 'cancel';
+        }
+
+        namespace MeterEventAdjustmentCreateParams {
+          interface Cancel {
+            /**
+             * Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+             */
+            identifier: string;
+          }
+        }
+      }
+
+      namespace Billing {
+        class MeterEventAdjustmentsResource {
+          /**
+           * Creates a meter event adjustment to cancel a previously sent meter event.
+           */
+          create(
+            params: MeterEventAdjustmentCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEventAdjustment>>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface MeterEventSessionCreateParams {}
+      }
+
+      namespace Billing {
+        class MeterEventSessionResource {
+          /**
+           * Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires.
+           */
+          create(
+            params?: MeterEventSessionCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEventSession>>;
+          create(
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEventSession>>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The MeterEventSession object.
+         */
+        interface MeterEventSession {
+          /**
+           * The unique id of this auth session.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'billing.meter_event_session';
+
+          /**
+           * The authentication token for this session.  Use this token when calling the
+           * high-throughput meter event API.
+           */
+          authentication_token: string;
+
+          /**
+           * The creation time of this session.
+           */
+          created: string;
+
+          /**
+           * The time at which this session will expire.
+           */
+          expires_at: 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;
+        }
+      }
+    }
+  }
+}

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>>;
+        }
+      }
+    }
+  }
+}