// File generated from our OpenAPI spec

declare module 'stripe' {
  namespace Stripe {
    namespace Issuing {
      interface DisputeCreateParams {
        /**
         * The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If not set, defaults to the full transaction amount.
         */
        amount?: number;

        /**
         * Evidence provided for the dispute.
         */
        evidence?: DisputeCreateParams.Evidence;

        /**
         * 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?: Stripe.MetadataParam;

        /**
         * The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
         */
        transaction?: string;

        /**
         * Params for disputes related to Treasury FinancialAccounts
         */
        treasury?: DisputeCreateParams.Treasury;
      }

      namespace DisputeCreateParams {
        interface Evidence {
          /**
           * Evidence provided when `reason` is 'canceled'.
           */
          canceled?: Stripe.Emptyable<Evidence.Canceled>;

          /**
           * Evidence provided when `reason` is 'duplicate'.
           */
          duplicate?: Stripe.Emptyable<Evidence.Duplicate>;

          /**
           * Evidence provided when `reason` is 'fraudulent'.
           */
          fraudulent?: Stripe.Emptyable<Evidence.Fraudulent>;

          /**
           * Evidence provided when `reason` is 'merchandise_not_as_described'.
           */
          merchandise_not_as_described?: Stripe.Emptyable<
            Evidence.MerchandiseNotAsDescribed
          >;

          /**
           * Evidence provided when `reason` is 'no_valid_authorization'.
           */
          no_valid_authorization?: Stripe.Emptyable<
            Evidence.NoValidAuthorization
          >;

          /**
           * Evidence provided when `reason` is 'not_received'.
           */
          not_received?: Stripe.Emptyable<Evidence.NotReceived>;

          /**
           * Evidence provided when `reason` is 'other'.
           */
          other?: Stripe.Emptyable<Evidence.Other>;

          /**
           * The reason for filing the dispute. The evidence should be submitted in the field of the same name.
           */
          reason?: Evidence.Reason;

          /**
           * Evidence provided when `reason` is 'service_not_as_described'.
           */
          service_not_as_described?: Stripe.Emptyable<
            Evidence.ServiceNotAsDescribed
          >;
        }

        namespace Evidence {
          interface Canceled {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Date when order was canceled.
             */
            canceled_at?: Stripe.Emptyable<number>;

            /**
             * Whether the cardholder was provided with a cancellation policy.
             */
            cancellation_policy_provided?: Stripe.Emptyable<boolean>;

            /**
             * Reason for canceling the order.
             */
            cancellation_reason?: Stripe.Emptyable<string>;

            /**
             * Date when the cardholder expected to receive the product.
             */
            expected_at?: Stripe.Emptyable<number>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Description of the merchandise or service that was purchased.
             */
            product_description?: Stripe.Emptyable<string>;

            /**
             * Whether the product was a merchandise or service.
             */
            product_type?: Stripe.Emptyable<Canceled.ProductType>;

            /**
             * Result of cardholder's attempt to return the product.
             */
            return_status?: Stripe.Emptyable<Canceled.ReturnStatus>;

            /**
             * Date when the product was returned or attempted to be returned.
             */
            returned_at?: Stripe.Emptyable<number>;
          }

          namespace Canceled {
            type ProductType = 'merchandise' | 'service';

            type ReturnStatus = 'merchant_rejected' | 'successful';
          }

          interface Duplicate {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
             */
            card_statement?: Stripe.Emptyable<string>;

            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
             */
            cash_receipt?: Stripe.Emptyable<string>;

            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
             */
            check_image?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
             */
            original_transaction?: string;
          }

          interface Fraudulent {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;
          }

          interface MerchandiseNotAsDescribed {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Date when the product was received.
             */
            received_at?: Stripe.Emptyable<number>;

            /**
             * Description of the cardholder's attempt to return the product.
             */
            return_description?: Stripe.Emptyable<string>;

            /**
             * Result of cardholder's attempt to return the product.
             */
            return_status?: Stripe.Emptyable<
              MerchandiseNotAsDescribed.ReturnStatus
            >;

            /**
             * Date when the product was returned or attempted to be returned.
             */
            returned_at?: Stripe.Emptyable<number>;
          }

          namespace MerchandiseNotAsDescribed {
            type ReturnStatus = 'merchant_rejected' | 'successful';
          }

          interface NotReceived {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Date when the cardholder expected to receive the product.
             */
            expected_at?: Stripe.Emptyable<number>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Description of the merchandise or service that was purchased.
             */
            product_description?: Stripe.Emptyable<string>;

            /**
             * Whether the product was a merchandise or service.
             */
            product_type?: Stripe.Emptyable<NotReceived.ProductType>;
          }

          namespace NotReceived {
            type ProductType = 'merchandise' | 'service';
          }

          interface NoValidAuthorization {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;
          }

          interface Other {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Description of the merchandise or service that was purchased.
             */
            product_description?: Stripe.Emptyable<string>;

            /**
             * Whether the product was a merchandise or service.
             */
            product_type?: Stripe.Emptyable<Other.ProductType>;
          }

          namespace Other {
            type ProductType = 'merchandise' | 'service';
          }

          type Reason =
            | 'canceled'
            | 'duplicate'
            | 'fraudulent'
            | 'merchandise_not_as_described'
            | 'no_valid_authorization'
            | 'not_received'
            | 'other'
            | 'service_not_as_described';

          interface ServiceNotAsDescribed {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Date when order was canceled.
             */
            canceled_at?: Stripe.Emptyable<number>;

            /**
             * Reason for canceling the order.
             */
            cancellation_reason?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Date when the product was received.
             */
            received_at?: Stripe.Emptyable<number>;
          }
        }

        interface Treasury {
          /**
           * The ID of the ReceivedDebit to initiate an Issuings dispute for.
           */
          received_debit: string;
        }
      }

      interface DisputeRetrieveParams {
        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;
      }

      interface DisputeUpdateParams {
        /**
         * The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
         */
        amount?: number;

        /**
         * Evidence provided for the dispute.
         */
        evidence?: DisputeUpdateParams.Evidence;

        /**
         * 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?: Stripe.Emptyable<Stripe.MetadataParam>;
      }

      namespace DisputeUpdateParams {
        interface Evidence {
          /**
           * Evidence provided when `reason` is 'canceled'.
           */
          canceled?: Stripe.Emptyable<Evidence.Canceled>;

          /**
           * Evidence provided when `reason` is 'duplicate'.
           */
          duplicate?: Stripe.Emptyable<Evidence.Duplicate>;

          /**
           * Evidence provided when `reason` is 'fraudulent'.
           */
          fraudulent?: Stripe.Emptyable<Evidence.Fraudulent>;

          /**
           * Evidence provided when `reason` is 'merchandise_not_as_described'.
           */
          merchandise_not_as_described?: Stripe.Emptyable<
            Evidence.MerchandiseNotAsDescribed
          >;

          /**
           * Evidence provided when `reason` is 'no_valid_authorization'.
           */
          no_valid_authorization?: Stripe.Emptyable<
            Evidence.NoValidAuthorization
          >;

          /**
           * Evidence provided when `reason` is 'not_received'.
           */
          not_received?: Stripe.Emptyable<Evidence.NotReceived>;

          /**
           * Evidence provided when `reason` is 'other'.
           */
          other?: Stripe.Emptyable<Evidence.Other>;

          /**
           * The reason for filing the dispute. The evidence should be submitted in the field of the same name.
           */
          reason?: Evidence.Reason;

          /**
           * Evidence provided when `reason` is 'service_not_as_described'.
           */
          service_not_as_described?: Stripe.Emptyable<
            Evidence.ServiceNotAsDescribed
          >;
        }

        namespace Evidence {
          interface Canceled {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Date when order was canceled.
             */
            canceled_at?: Stripe.Emptyable<number>;

            /**
             * Whether the cardholder was provided with a cancellation policy.
             */
            cancellation_policy_provided?: Stripe.Emptyable<boolean>;

            /**
             * Reason for canceling the order.
             */
            cancellation_reason?: Stripe.Emptyable<string>;

            /**
             * Date when the cardholder expected to receive the product.
             */
            expected_at?: Stripe.Emptyable<number>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Description of the merchandise or service that was purchased.
             */
            product_description?: Stripe.Emptyable<string>;

            /**
             * Whether the product was a merchandise or service.
             */
            product_type?: Stripe.Emptyable<Canceled.ProductType>;

            /**
             * Result of cardholder's attempt to return the product.
             */
            return_status?: Stripe.Emptyable<Canceled.ReturnStatus>;

            /**
             * Date when the product was returned or attempted to be returned.
             */
            returned_at?: Stripe.Emptyable<number>;
          }

          namespace Canceled {
            type ProductType = 'merchandise' | 'service';

            type ReturnStatus = 'merchant_rejected' | 'successful';
          }

          interface Duplicate {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
             */
            card_statement?: Stripe.Emptyable<string>;

            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
             */
            cash_receipt?: Stripe.Emptyable<string>;

            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
             */
            check_image?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
             */
            original_transaction?: string;
          }

          interface Fraudulent {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;
          }

          interface MerchandiseNotAsDescribed {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Date when the product was received.
             */
            received_at?: Stripe.Emptyable<number>;

            /**
             * Description of the cardholder's attempt to return the product.
             */
            return_description?: Stripe.Emptyable<string>;

            /**
             * Result of cardholder's attempt to return the product.
             */
            return_status?: Stripe.Emptyable<
              MerchandiseNotAsDescribed.ReturnStatus
            >;

            /**
             * Date when the product was returned or attempted to be returned.
             */
            returned_at?: Stripe.Emptyable<number>;
          }

          namespace MerchandiseNotAsDescribed {
            type ReturnStatus = 'merchant_rejected' | 'successful';
          }

          interface NotReceived {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Date when the cardholder expected to receive the product.
             */
            expected_at?: Stripe.Emptyable<number>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Description of the merchandise or service that was purchased.
             */
            product_description?: Stripe.Emptyable<string>;

            /**
             * Whether the product was a merchandise or service.
             */
            product_type?: Stripe.Emptyable<NotReceived.ProductType>;
          }

          namespace NotReceived {
            type ProductType = 'merchandise' | 'service';
          }

          interface NoValidAuthorization {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;
          }

          interface Other {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Description of the merchandise or service that was purchased.
             */
            product_description?: Stripe.Emptyable<string>;

            /**
             * Whether the product was a merchandise or service.
             */
            product_type?: Stripe.Emptyable<Other.ProductType>;
          }

          namespace Other {
            type ProductType = 'merchandise' | 'service';
          }

          type Reason =
            | 'canceled'
            | 'duplicate'
            | 'fraudulent'
            | 'merchandise_not_as_described'
            | 'no_valid_authorization'
            | 'not_received'
            | 'other'
            | 'service_not_as_described';

          interface ServiceNotAsDescribed {
            /**
             * (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
             */
            additional_documentation?: Stripe.Emptyable<string>;

            /**
             * Date when order was canceled.
             */
            canceled_at?: Stripe.Emptyable<number>;

            /**
             * Reason for canceling the order.
             */
            cancellation_reason?: Stripe.Emptyable<string>;

            /**
             * Explanation of why the cardholder is disputing this transaction.
             */
            explanation?: Stripe.Emptyable<string>;

            /**
             * Date when the product was received.
             */
            received_at?: Stripe.Emptyable<number>;
          }
        }
      }

      interface DisputeListParams extends PaginationParams {
        /**
         * Only return Issuing disputes that were created during the given date interval.
         */
        created?: Stripe.RangeQueryParam | number;

        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;

        /**
         * Select Issuing disputes with the given status.
         */
        status?: DisputeListParams.Status;

        /**
         * Select the Issuing dispute for the given transaction.
         */
        transaction?: string;
      }

      namespace DisputeListParams {
        type Status = 'expired' | 'lost' | 'submitted' | 'unsubmitted' | 'won';
      }

      interface DisputeSubmitParams {
        /**
         * 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?: Stripe.Emptyable<Stripe.MetadataParam>;
      }

      class DisputesResource {
        /**
         * Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
         */
        create(
          params?: DisputeCreateParams,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;
        create(
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;

        /**
         * Retrieves an Issuing Dispute object.
         */
        retrieve(
          id: string,
          params?: DisputeRetrieveParams,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;
        retrieve(
          id: string,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;

        /**
         * Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.
         */
        update(
          id: string,
          params?: DisputeUpdateParams,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;

        /**
         * Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
         */
        list(
          params?: DisputeListParams,
          options?: RequestOptions
        ): ApiListPromise<Stripe.Issuing.Dispute>;
        list(options?: RequestOptions): ApiListPromise<Stripe.Issuing.Dispute>;

        /**
         * Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
         */
        submit(
          id: string,
          params?: DisputeSubmitParams,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;
        submit(
          id: string,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;
      }
    }
  }
}
