@noodleseed/one 0.54.0 → 0.56.0

package/node_modules/stripe/esm/resources/Refunds.d.ts

@@ -0,0 +1,505 @@
+import { StripeResource } from '../StripeResource.js';
+import { BalanceTransaction } from './BalanceTransactions.js';
+import { Charge } from './Charges.js';
+import { PaymentIntent } from './PaymentIntents.js';
+import { TransferReversal } from './TransferReversals.js';
+import { Emptyable, MetadataParam, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../lib.js';
+export declare class RefundResource extends StripeResource {
+    /**
+     * Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
+     */
+    list(params?: RefundListParams, options?: RequestOptions): ApiListPromise<Refund>;
+    /**
+     * When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+     *
+     * Creating a new refund will refund a charge that has previously been created but not yet refunded.
+     * Funds will be refunded to the credit or debit card that was originally charged.
+     *
+     * You can optionally refund only part of a charge.
+     * You can do so multiple times, until the entire charge has been refunded.
+     *
+     * Once entirely refunded, a charge can't be refunded again.
+     * This method will raise an error when called on an already-refunded charge,
+     * or when trying to refund more money than is left on a charge.
+     */
+    create(params?: RefundCreateParams, options?: RequestOptions): Promise<Response<Refund>>;
+    /**
+     * Retrieves the details of an existing refund.
+     */
+    retrieve(id: string, params?: RefundRetrieveParams, options?: RequestOptions): Promise<Response<Refund>>;
+    /**
+     * Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
+     *
+     * This request only accepts metadata as an argument.
+     */
+    update(id: string, params?: RefundUpdateParams, options?: RequestOptions): Promise<Response<Refund>>;
+    /**
+     * Cancels a refund with a status of requires_action.
+     *
+     * You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
+     */
+    cancel(id: string, params?: RefundCancelParams, options?: RequestOptions): Promise<Response<Refund>>;
+}
+export interface Refund {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'refund';
+    /**
+     * Amount, in cents (or local equivalent).
+     */
+    amount: number;
+    /**
+     * Balance transaction that describes the impact on your account balance.
+     */
+    balance_transaction: string | BalanceTransaction | null;
+    /**
+     * ID of the charge that's refunded.
+     */
+    charge: string | Charge | null;
+    /**
+     * 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;
+    /**
+     * An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).
+     */
+    description?: string;
+    destination_details?: Refund.DestinationDetails;
+    /**
+     * After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
+     */
+    failure_balance_transaction?: string | BalanceTransaction;
+    /**
+     * Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.
+     */
+    failure_reason?: string;
+    /**
+     * For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
+     */
+    instructions_email?: 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.
+     */
+    metadata: Metadata | null;
+    next_action?: Refund.NextAction;
+    /**
+     * ID of the PaymentIntent that's refunded.
+     */
+    payment_intent: string | PaymentIntent | null;
+    /**
+     * Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`.
+     */
+    pending_reason?: Refund.PendingReason;
+    presentment_details?: Refund.PresentmentDetails;
+    /**
+     * Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
+     */
+    reason: Refund.Reason | null;
+    /**
+     * This is the transaction number that appears on email receipts sent for this refund.
+     */
+    receipt_number: string | null;
+    /**
+     * The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.
+     */
+    source_transfer_reversal: string | TransferReversal | null;
+    /**
+     * Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds).
+     */
+    status: string | null;
+    /**
+     * This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.
+     */
+    transfer_reversal: string | TransferReversal | null;
+}
+export declare namespace Refund {
+    interface DestinationDetails {
+        affirm?: DestinationDetails.Affirm;
+        afterpay_clearpay?: DestinationDetails.AfterpayClearpay;
+        alipay?: DestinationDetails.Alipay;
+        alma?: DestinationDetails.Alma;
+        amazon_pay?: DestinationDetails.AmazonPay;
+        au_bank_transfer?: DestinationDetails.AuBankTransfer;
+        blik?: DestinationDetails.Blik;
+        br_bank_transfer?: DestinationDetails.BrBankTransfer;
+        card?: DestinationDetails.Card;
+        cashapp?: DestinationDetails.Cashapp;
+        crypto?: DestinationDetails.Crypto;
+        customer_cash_balance?: DestinationDetails.CustomerCashBalance;
+        eps?: DestinationDetails.Eps;
+        eu_bank_transfer?: DestinationDetails.EuBankTransfer;
+        gb_bank_transfer?: DestinationDetails.GbBankTransfer;
+        giropay?: DestinationDetails.Giropay;
+        grabpay?: DestinationDetails.Grabpay;
+        jp_bank_transfer?: DestinationDetails.JpBankTransfer;
+        klarna?: DestinationDetails.Klarna;
+        mb_way?: DestinationDetails.MbWay;
+        multibanco?: DestinationDetails.Multibanco;
+        mx_bank_transfer?: DestinationDetails.MxBankTransfer;
+        nz_bank_transfer?: DestinationDetails.NzBankTransfer;
+        p24?: DestinationDetails.P24;
+        paynow?: DestinationDetails.Paynow;
+        paypal?: DestinationDetails.Paypal;
+        pix?: DestinationDetails.Pix;
+        revolut?: DestinationDetails.Revolut;
+        scalapay?: DestinationDetails.Scalapay;
+        sofort?: DestinationDetails.Sofort;
+        swish?: DestinationDetails.Swish;
+        th_bank_transfer?: DestinationDetails.ThBankTransfer;
+        twint?: DestinationDetails.Twint;
+        /**
+         * The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.
+         */
+        type: string;
+        us_bank_transfer?: DestinationDetails.UsBankTransfer;
+        wechat_pay?: DestinationDetails.WechatPay;
+        zip?: DestinationDetails.Zip;
+    }
+    interface NextAction {
+        display_details?: NextAction.DisplayDetails;
+        /**
+         * Type of the next action to perform.
+         */
+        type: string;
+    }
+    type PendingReason = 'charge_pending' | 'insufficient_funds' | 'processing';
+    interface PresentmentDetails {
+        /**
+         * Amount intended to be collected by this payment, denominated in `presentment_currency`.
+         */
+        presentment_amount: number;
+        /**
+         * Currency presented to the customer during payment.
+         */
+        presentment_currency: string;
+    }
+    type Reason = 'duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer';
+    namespace DestinationDetails {
+        interface Affirm {
+        }
+        interface AfterpayClearpay {
+        }
+        interface Alipay {
+        }
+        interface Alma {
+        }
+        interface AmazonPay {
+        }
+        interface AuBankTransfer {
+        }
+        interface Blik {
+            /**
+             * For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
+             */
+            network_decline_code: string | null;
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface BrBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface Card {
+            /**
+             * Value of the reference number assigned to the refund.
+             */
+            reference?: string;
+            /**
+             * Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status?: string;
+            /**
+             * Type of the reference number assigned to the refund.
+             */
+            reference_type?: string;
+            /**
+             * The type of refund. This can be `refund`, `reversal`, or `pending`.
+             */
+            type: Card.Type;
+        }
+        interface Cashapp {
+        }
+        interface Crypto {
+            /**
+             * The transaction hash of the refund.
+             */
+            reference: string | null;
+        }
+        interface CustomerCashBalance {
+        }
+        interface Eps {
+        }
+        interface EuBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface GbBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface Giropay {
+        }
+        interface Grabpay {
+        }
+        interface JpBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface Klarna {
+        }
+        interface MbWay {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface Multibanco {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface MxBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface NzBankTransfer {
+        }
+        interface P24 {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface Paynow {
+        }
+        interface Paypal {
+            /**
+             * For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
+             */
+            network_decline_code: string | null;
+        }
+        interface Pix {
+        }
+        interface Revolut {
+        }
+        interface Scalapay {
+        }
+        interface Sofort {
+        }
+        interface Swish {
+            /**
+             * For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
+             */
+            network_decline_code: string | null;
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface ThBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface Twint {
+        }
+        interface UsBankTransfer {
+            /**
+             * The reference assigned to the refund.
+             */
+            reference: string | null;
+            /**
+             * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+             */
+            reference_status: string | null;
+        }
+        interface WechatPay {
+        }
+        interface Zip {
+        }
+        namespace Card {
+            type Type = 'pending' | 'refund' | 'reversal';
+        }
+    }
+    namespace NextAction {
+        interface DisplayDetails {
+            email_sent: DisplayDetails.EmailSent;
+            /**
+             * The expiry timestamp.
+             */
+            expires_at: number;
+        }
+        namespace DisplayDetails {
+            interface EmailSent {
+                /**
+                 * The timestamp when the email was sent.
+                 */
+                email_sent_at: number;
+                /**
+                 * The recipient's email address.
+                 */
+                email_sent_to: string;
+            }
+        }
+    }
+}
+export interface RefundCreateParams {
+    amount?: number;
+    /**
+     * The identifier of the charge to refund.
+     */
+    charge?: string;
+    /**
+     * 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;
+    /**
+     * Customer whose customer balance to refund from.
+     */
+    customer?: string;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
+     */
+    instructions_email?: 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?: Emptyable<MetadataParam>;
+    /**
+     * Origin of the refund
+     */
+    origin?: 'customer_balance';
+    /**
+     * The identifier of the PaymentIntent to refund.
+     */
+    payment_intent?: string;
+    /**
+     * String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms.
+     */
+    reason?: RefundCreateParams.Reason;
+    /**
+     * Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
+     */
+    refund_application_fee?: boolean;
+    /**
+     * Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
+     *
+     * A transfer can be reversed only by the application that created the charge.
+     */
+    reverse_transfer?: boolean;
+}
+export declare namespace RefundCreateParams {
+    type Reason = 'duplicate' | 'fraudulent' | 'requested_by_customer';
+}
+export interface RefundRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface RefundUpdateParams {
+    /**
+     * 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?: Emptyable<MetadataParam>;
+}
+export interface RefundListParams extends PaginationParams {
+    /**
+     * Only return refunds for the charge specified by this charge ID.
+     */
+    charge?: string;
+    /**
+     * Only return refunds that were created during the given date interval.
+     */
+    created?: RangeQueryParam | number;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Only return refunds for the PaymentIntent specified by this ID.
+     */
+    payment_intent?: string;
+}
+export interface RefundCancelParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}

package/node_modules/stripe/esm/resources/Refunds.js

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../StripeResource.js';
+export class RefundResource extends StripeResource {
+    /**
+     * Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/refunds', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+     *
+     * Creating a new refund will refund a charge that has previously been created but not yet refunded.
+     * Funds will be refunded to the credit or debit card that was originally charged.
+     *
+     * You can optionally refund only part of a charge.
+     * You can do so multiple times, until the entire charge has been refunded.
+     *
+     * Once entirely refunded, a charge can't be refunded again.
+     * This method will raise an error when called on an already-refunded charge,
+     * or when trying to refund more money than is left on a charge.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/refunds', params, options);
+    }
+    /**
+     * Retrieves the details of an existing refund.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/refunds/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
+     *
+     * This request only accepts metadata as an argument.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/refunds/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Cancels a refund with a status of requires_action.
+     *
+     * You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
+     */
+    cancel(id, params, options) {
+        return this._makeRequest('POST', `/v1/refunds/${encodeURIComponent(id)}/cancel`, params, options);
+    }
+}
+//# sourceMappingURL=Refunds.js.map

package/node_modules/stripe/esm/resources/Refunds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Refunds.js","sourceRoot":"","sources":["../../src/resources/Refunds.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAcpD,MAAM,OAAO,cAAe,SAAQ,cAAc;IAChD;;OAEG;IACH,IAAI,CACF,MAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;YAC9D,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,CAAQ,CAAC;IAC1E,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,eAAe,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACvC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,eAAe,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACvC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,eAAe,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAC9C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}