Initial project import

node_modules/stripe/esm/resources/Treasury/CreditReversals.d.ts

@@ -0,0 +1,132 @@
+import { StripeResource } from '../../StripeResource.js';
+import { Transaction } from './Transactions.js';
+import { MetadataParam, PaginationParams, Metadata } from '../../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
+export declare class CreditReversalResource extends StripeResource {
+    /**
+     * Returns a list of CreditReversals.
+     */
+    list(params: Treasury.CreditReversalListParams, options?: RequestOptions): ApiListPromise<CreditReversal>;
+    /**
+     * Reverses a ReceivedCredit and creates a CreditReversal object.
+     */
+    create(params: Treasury.CreditReversalCreateParams, options?: RequestOptions): Promise<Response<CreditReversal>>;
+    /**
+     * Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list
+     */
+    retrieve(id: string, params?: Treasury.CreditReversalRetrieveParams, options?: RequestOptions): Promise<Response<CreditReversal>>;
+}
+export interface CreditReversal {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'treasury.credit_reversal';
+    /**
+     * Amount (in cents) transferred.
+     */
+    amount: number;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: 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;
+    /**
+     * A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+     */
+    hosted_regulatory_receipt_url: string | null;
+    /**
+     * 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: Metadata;
+    /**
+     * The rails used to reverse the funds.
+     */
+    network: Treasury.CreditReversal.Network;
+    /**
+     * The ReceivedCredit being reversed.
+     */
+    received_credit: string;
+    /**
+     * Status of the CreditReversal
+     */
+    status: Treasury.CreditReversal.Status;
+    status_transitions: Treasury.CreditReversal.StatusTransitions;
+    /**
+     * The Transaction associated with this object.
+     */
+    transaction: string | Transaction | null;
+}
+export declare namespace Treasury {
+    namespace CreditReversal {
+        type Network = 'ach' | 'stripe';
+        type Status = 'canceled' | 'posted' | 'processing';
+        interface StatusTransitions {
+            /**
+             * Timestamp describing when the CreditReversal changed status to `posted`
+             */
+            posted_at: number | null;
+        }
+    }
+}
+export declare namespace Treasury {
+    interface CreditReversalCreateParams {
+        /**
+         * The ReceivedCredit to reverse.
+         */
+        received_credit: string;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * 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. 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?: MetadataParam;
+    }
+}
+export declare namespace Treasury {
+    interface CreditReversalRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Treasury {
+    interface CreditReversalListParams 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 CreditReversals for the ReceivedCredit ID.
+         */
+        received_credit?: string;
+        /**
+         * Only return CreditReversals for a given status.
+         */
+        status?: CreditReversalListParams.Status;
+    }
+    namespace CreditReversalListParams {
+        type Status = 'canceled' | 'posted' | 'processing';
+    }
+}