@depup/stripe 21.0.0-depup.0

package/types/TestHelpers/RefundsResource.d.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      interface RefundExpireParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class RefundsResource {
+        /**
+         * Expire a refund with a status of requires_action.
+         */
+        expire(
+          id: string,
+          params?: RefundExpireParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Refund>>;
+        expire(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Refund>>;
+      }
+    }
+  }
+}

package/types/TestHelpers/Terminal/ReadersResource.d.ts

@@ -0,0 +1,151 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Terminal {
+        interface ReaderPresentPaymentMethodParams {
+          /**
+           * Simulated on-reader tip amount.
+           */
+          amount_tip?: number;
+
+          /**
+           * Simulated data for the card payment method.
+           */
+          card?: ReaderPresentPaymentMethodParams.Card;
+
+          /**
+           * Simulated data for the card_present payment method.
+           */
+          card_present?: ReaderPresentPaymentMethodParams.CardPresent;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Simulated data for the interac_present payment method.
+           */
+          interac_present?: ReaderPresentPaymentMethodParams.InteracPresent;
+
+          /**
+           * Simulated payment type.
+           */
+          type?: ReaderPresentPaymentMethodParams.Type;
+        }
+
+        namespace ReaderPresentPaymentMethodParams {
+          interface Card {
+            /**
+             * Card security code.
+             */
+            cvc?: string;
+
+            /**
+             * Two-digit number representing the card's expiration month.
+             */
+            exp_month: number;
+
+            /**
+             * Two- or four-digit number representing the card's expiration year.
+             */
+            exp_year: number;
+
+            /**
+             * The card number, as a string without any separators.
+             */
+            number: string;
+          }
+
+          interface CardPresent {
+            /**
+             * The card number, as a string without any separators.
+             */
+            number?: string;
+          }
+
+          interface InteracPresent {
+            /**
+             * The Interac card number.
+             */
+            number?: string;
+          }
+
+          type Type = 'card' | 'card_present' | 'interac_present';
+        }
+      }
+
+      namespace Terminal {
+        interface ReaderSucceedInputCollectionParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * This parameter defines the skip behavior for input collection.
+           */
+          skip_non_required_inputs?: ReaderSucceedInputCollectionParams.SkipNonRequiredInputs;
+        }
+
+        namespace ReaderSucceedInputCollectionParams {
+          type SkipNonRequiredInputs = 'all' | 'none';
+        }
+      }
+
+      namespace Terminal {
+        interface ReaderTimeoutInputCollectionParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Terminal {
+        class ReadersResource {
+          /**
+           * Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
+           */
+          presentPaymentMethod(
+            id: string,
+            params?: ReaderPresentPaymentMethodParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+          presentPaymentMethod(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+          /**
+           * Use this endpoint to trigger a successful input collection on a simulated reader.
+           */
+          succeedInputCollection(
+            id: string,
+            params?: ReaderSucceedInputCollectionParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+          succeedInputCollection(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+          /**
+           * Use this endpoint to complete an input collection with a timeout error on a simulated reader.
+           */
+          timeoutInputCollection(
+            id: string,
+            params?: ReaderTimeoutInputCollectionParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+          timeoutInputCollection(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+        }
+      }
+    }
+  }
+}

package/types/TestHelpers/TestClocks.d.ts

@@ -0,0 +1,98 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      /**
+       * The DeletedTestClock object.
+       */
+      interface DeletedTestClock {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'test_helpers.test_clock';
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted: true;
+      }
+
+      /**
+       * A test clock enables deterministic control over objects in testmode. With a test clock, you can create
+       * objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,
+       * you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
+       */
+      interface TestClock {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'test_helpers.test_clock';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Always true for a deleted object
+         */
+        deleted?: void;
+
+        /**
+         * Time at which this clock is scheduled to auto delete.
+         */
+        deletes_after: number;
+
+        /**
+         * Time at which all objects belonging to this clock are frozen.
+         */
+        frozen_time: number;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * The custom name supplied at creation.
+         */
+        name: string | null;
+
+        /**
+         * The status of the Test Clock.
+         */
+        status: TestClock.Status;
+
+        status_details: TestClock.StatusDetails;
+      }
+
+      namespace TestClock {
+        type Status = 'advancing' | 'internal_failure' | 'ready';
+
+        interface StatusDetails {
+          advancing?: StatusDetails.Advancing;
+        }
+
+        namespace StatusDetails {
+          interface Advancing {
+            /**
+             * The `frozen_time` that the Test Clock is advancing towards.
+             */
+            target_frozen_time: number;
+          }
+        }
+      }
+    }
+  }
+}

package/types/TestHelpers/TestClocksResource.d.ts

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      interface TestClockCreateParams {
+        /**
+         * The initial frozen time for this test clock.
+         */
+        frozen_time: number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The name for this test clock.
+         */
+        name?: string;
+      }
+
+      interface TestClockRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface TestClockListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface TestClockDeleteParams {}
+
+      interface TestClockAdvanceParams {
+        /**
+         * The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.
+         */
+        frozen_time: number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class TestClocksResource {
+        /**
+         * Creates a new test clock that can be attached to new customers and quotes.
+         */
+        create(
+          params: TestClockCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.TestHelpers.TestClock>>;
+
+        /**
+         * Retrieves a test clock.
+         */
+        retrieve(
+          id: string,
+          params?: TestClockRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.TestHelpers.TestClock>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.TestHelpers.TestClock>>;
+
+        /**
+         * Returns a list of your test clocks.
+         */
+        list(
+          params?: TestClockListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.TestHelpers.TestClock>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.TestHelpers.TestClock>;
+
+        /**
+         * Deletes a test clock.
+         */
+        del(
+          id: string,
+          params?: TestClockDeleteParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.TestHelpers.DeletedTestClock>>;
+        del(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.TestHelpers.DeletedTestClock>>;
+
+        /**
+         * Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
+         */
+        advance(
+          id: string,
+          params: TestClockAdvanceParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.TestHelpers.TestClock>>;
+      }
+    }
+  }
+}

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

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface InboundTransferFailParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Details about a failed InboundTransfer.
+           */
+          failure_details?: InboundTransferFailParams.FailureDetails;
+        }
+
+        namespace InboundTransferFailParams {
+          interface FailureDetails {
+            /**
+             * Reason for the failure.
+             */
+            code?: FailureDetails.Code;
+          }
+
+          namespace FailureDetails {
+            type Code =
+              | 'account_closed'
+              | 'account_frozen'
+              | 'bank_account_restricted'
+              | 'bank_ownership_changed'
+              | 'debit_not_authorized'
+              | 'incorrect_account_holder_address'
+              | 'incorrect_account_holder_name'
+              | 'incorrect_account_holder_tax_id'
+              | 'insufficient_funds'
+              | 'invalid_account_number'
+              | 'invalid_currency'
+              | 'no_account'
+              | 'other';
+          }
+        }
+      }
+
+      namespace Treasury {
+        interface InboundTransferReturnInboundTransferParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface InboundTransferSucceedParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        class InboundTransfersResource {
+          /**
+           * Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
+           */
+          fail(
+            id: string,
+            params?: InboundTransferFailParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+          fail(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+
+          /**
+           * Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
+           */
+          returnInboundTransfer(
+            id: string,
+            params?: InboundTransferReturnInboundTransferParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+          returnInboundTransfer(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+
+          /**
+           * Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
+           */
+          succeed(
+            id: string,
+            params?: InboundTransferSucceedParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+          succeed(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.InboundTransfer>>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,175 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Treasury {
+        interface OutboundPaymentUpdateParams {
+          /**
+           * Details about network-specific tracking information.
+           */
+          tracking_details: OutboundPaymentUpdateParams.TrackingDetails;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+
+        namespace OutboundPaymentUpdateParams {
+          interface TrackingDetails {
+            /**
+             * ACH network tracking details.
+             */
+            ach?: TrackingDetails.Ach;
+
+            /**
+             * The US bank account network used to send funds.
+             */
+            type: TrackingDetails.Type;
+
+            /**
+             * US domestic wire network tracking details.
+             */
+            us_domestic_wire?: TrackingDetails.UsDomesticWire;
+          }
+
+          namespace TrackingDetails {
+            interface Ach {
+              /**
+               * ACH trace ID for funds sent over the `ach` network.
+               */
+              trace_id: string;
+            }
+
+            type Type = 'ach' | 'us_domestic_wire';
+
+            interface UsDomesticWire {
+              /**
+               * CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
+               */
+              chips?: string;
+
+              /**
+               * IMAD for funds sent over the `us_domestic_wire` network.
+               */
+              imad?: string;
+
+              /**
+               * OMAD for funds sent over the `us_domestic_wire` network.
+               */
+              omad?: string;
+            }
+          }
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundPaymentFailParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundPaymentPostParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+        }
+      }
+
+      namespace Treasury {
+        interface OutboundPaymentReturnOutboundPaymentParams {
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Optional hash to set the return code.
+           */
+          returned_details?: OutboundPaymentReturnOutboundPaymentParams.ReturnedDetails;
+        }
+
+        namespace OutboundPaymentReturnOutboundPaymentParams {
+          interface ReturnedDetails {
+            /**
+             * The return code to be set on the OutboundPayment object.
+             */
+            code?: ReturnedDetails.Code;
+          }
+
+          namespace ReturnedDetails {
+            type Code =
+              | 'account_closed'
+              | 'account_frozen'
+              | 'bank_account_restricted'
+              | 'bank_ownership_changed'
+              | 'declined'
+              | 'incorrect_account_holder_name'
+              | 'invalid_account_number'
+              | 'invalid_currency'
+              | 'no_account'
+              | 'other';
+          }
+        }
+      }
+
+      namespace Treasury {
+        class OutboundPaymentsResource {
+          /**
+           * Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.
+           */
+          update(
+            id: string,
+            params: OutboundPaymentUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+
+          /**
+           * Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
+           */
+          fail(
+            id: string,
+            params?: OutboundPaymentFailParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+          fail(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+
+          /**
+           * Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
+           */
+          post(
+            id: string,
+            params?: OutboundPaymentPostParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+          post(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+
+          /**
+           * Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
+           */
+          returnOutboundPayment(
+            id: string,
+            params?: OutboundPaymentReturnOutboundPaymentParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+          returnOutboundPayment(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Treasury.OutboundPayment>>;
+        }
+      }
+    }
+  }
+}