stripe 9.0.0 → 9.3.0

package/types/2020-08-27/Treasury/DebitReversals.d.ts

@@ -0,0 +1,187 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      /**
+       * The DebitReversal object.
+       */
+      interface DebitReversal {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'treasury.debit_reversal';
+
+        /**
+         * Amount (in cents) transferred.
+         */
+        amount: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * The FinancialAccount to reverse funds from.
+         */
+        financial_account: string | null;
+
+        /**
+         * A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+         */
+        hosted_regulatory_receipt_url: string | null;
+
+        /**
+         * Other flows linked to a DebitReversal.
+         */
+        linked_flows: DebitReversal.LinkedFlows | null;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/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 rails used to reverse the funds.
+         */
+        network: DebitReversal.Network;
+
+        /**
+         * The ReceivedDebit being reversed.
+         */
+        received_debit: string;
+
+        /**
+         * Status of the DebitReversal
+         */
+        status: DebitReversal.Status;
+
+        status_transitions: DebitReversal.StatusTransitions;
+
+        /**
+         * The Transaction associated with this object.
+         */
+        transaction: string | Stripe.Treasury.Transaction | null;
+      }
+
+      namespace DebitReversal {
+        interface LinkedFlows {
+          /**
+           * Set if there is an Issuing dispute associated with the DebitReversal.
+           */
+          issuing_dispute: string | null;
+        }
+
+        type Network = 'ach' | 'card';
+
+        type Status = 'failed' | 'processing' | 'succeeded';
+
+        interface StatusTransitions {
+          /**
+           * Timestamp describing when the DebitReversal changed status to `completed`.
+           */
+          completed_at: number | null;
+        }
+      }
+
+      interface DebitReversalCreateParams {
+        /**
+         * The ReceivedDebit to reverse.
+         */
+        received_debit: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+      }
+
+      interface DebitReversalRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface DebitReversalListParams extends PaginationParams {
+        /**
+         * Returns objects associated with this FinancialAccount.
+         */
+        financial_account: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return DebitReversals for the ReceivedDebit ID.
+         */
+        received_debit?: string;
+
+        /**
+         * Only return DebitReversals for a given resolution.
+         */
+        resolution?: DebitReversalListParams.Resolution;
+
+        /**
+         * Only return DebitReversals for a given status.
+         */
+        status?: DebitReversalListParams.Status;
+      }
+
+      namespace DebitReversalListParams {
+        type Resolution = 'lost' | 'won';
+
+        type Status = 'canceled' | 'completed' | 'processing';
+      }
+
+      class DebitReversalsResource {
+        /**
+         * Reverses a ReceivedDebit and creates a DebitReversal object.
+         */
+        create(
+          params: DebitReversalCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.DebitReversal>>;
+
+        /**
+         * Retrieves a DebitReversal object.
+         */
+        retrieve(
+          id: string,
+          params?: DebitReversalRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.DebitReversal>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.DebitReversal>>;
+
+        /**
+         * Returns a list of DebitReversals.
+         */
+        list(
+          params: DebitReversalListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.DebitReversal>;
+      }
+    }
+  }
+}