@depup/stripe 21.0.0-depup.0

package/types/Tax/TransactionsResource.d.ts

@@ -0,0 +1,182 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Tax {
+      interface TransactionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface TransactionCreateFromCalculationParams {
+        /**
+         * Tax Calculation ID to be used as input when creating the transaction.
+         */
+        calculation: string;
+
+        /**
+         * A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.
+         */
+        reference: 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?: Stripe.MetadataParam;
+
+        /**
+         * The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.
+         */
+        posted_at?: number;
+      }
+
+      interface TransactionCreateReversalParams {
+        /**
+         * If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.
+         */
+        mode: TransactionCreateReversalParams.Mode;
+
+        /**
+         * The ID of the Transaction to partially or fully reverse.
+         */
+        original_transaction: string;
+
+        /**
+         * A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://docs.stripe.com/tax/reports).
+         */
+        reference: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative. This value represents the total amount to refund from the transaction, including taxes.
+         */
+        flat_amount?: number;
+
+        /**
+         * The line item amounts to reverse.
+         */
+        line_items?: Array<TransactionCreateReversalParams.LineItem>;
+
+        /**
+         * 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 shipping cost to reverse.
+         */
+        shipping_cost?: TransactionCreateReversalParams.ShippingCost;
+      }
+
+      namespace TransactionCreateReversalParams {
+        interface LineItem {
+          /**
+           * The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
+           */
+          amount: number;
+
+          /**
+           * The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
+           */
+          amount_tax: number;
+
+          /**
+           * 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?: Stripe.MetadataParam;
+
+          /**
+           * The `id` of the line item to reverse in the original transaction.
+           */
+          original_line_item: string;
+
+          /**
+           * The quantity reversed. Appears in [tax exports](https://docs.stripe.com/tax/reports), but does not affect the amount of tax reversed.
+           */
+          quantity?: number;
+
+          /**
+           * A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.
+           */
+          reference: string;
+        }
+
+        type Mode = 'full' | 'partial';
+
+        interface ShippingCost {
+          /**
+           * The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
+           */
+          amount: number;
+
+          /**
+           * The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
+           */
+          amount_tax: number;
+        }
+      }
+
+      interface TransactionListLineItemsParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class TransactionsResource {
+        /**
+         * Retrieves a Tax Transaction object.
+         */
+        retrieve(
+          id: string,
+          params?: TransactionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Transaction>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Transaction>>;
+
+        /**
+         * Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.
+         */
+        createFromCalculation(
+          params: TransactionCreateFromCalculationParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Transaction>>;
+
+        /**
+         * Partially or fully reverses a previously created Transaction.
+         */
+        createReversal(
+          params: TransactionCreateReversalParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Transaction>>;
+
+        /**
+         * Retrieves the line items of a committed standalone transaction as a collection.
+         */
+        listLineItems(
+          id: string,
+          params?: TransactionListLineItemsParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Tax.TransactionLineItem>;
+        listLineItems(
+          id: string,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Tax.TransactionLineItem>;
+      }
+    }
+  }
+}

package/types/TaxCodes.d.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
+     */
+    interface TaxCode {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'tax_code';
+
+      /**
+       * A detailed description of which types of products the tax code represents.
+       */
+      description: string;
+
+      /**
+       * A short name for the tax code.
+       */
+      name: string;
+    }
+  }
+}

package/types/TaxCodesResource.d.ts

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface TaxCodeRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface TaxCodeListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class TaxCodesResource {
+      /**
+       * Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
+       */
+      retrieve(
+        id: string,
+        params?: TaxCodeRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TaxCode>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.TaxCode>>;
+
+      /**
+       * A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
+       */
+      list(
+        params?: TaxCodeListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.TaxCode>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.TaxCode>;
+    }
+  }
+}

package/types/TaxDeductedAtSources.d.ts

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The TaxDeductedAtSource object.
+     */
+    interface TaxDeductedAtSource {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'tax_deducted_at_source';
+
+      /**
+       * The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.
+       */
+      period_end: number;
+
+      /**
+       * The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.
+       */
+      period_start: number;
+
+      /**
+       * The TAN that was supplied to Stripe when TDS was assessed
+       */
+      tax_deduction_account_number: string;
+    }
+  }
+}

package/types/TaxIds.d.ts

@@ -0,0 +1,262 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The DeletedTaxId object.
+     */
+    interface DeletedTaxId {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'tax_id';
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted: true;
+    }
+
+    /**
+     * You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account.
+     * Customer and account tax IDs get displayed on related invoices and credit notes.
+     *
+     * Related guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids)
+     */
+    interface TaxId {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'tax_id';
+
+      /**
+       * Two-letter ISO code representing the country of the tax ID.
+       */
+      country: string | null;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * ID of the customer.
+       */
+      customer: string | Stripe.Customer | null;
+
+      /**
+       * ID of the Account representing the customer.
+       */
+      customer_account: string | null;
+
+      /**
+       * Always true for a deleted object
+       */
+      deleted?: void;
+
+      /**
+       * 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 account or customer the tax ID belongs to.
+       */
+      owner: TaxId.Owner | null;
+
+      /**
+       * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`
+       */
+      type: TaxId.Type;
+
+      /**
+       * Value of the tax ID.
+       */
+      value: string;
+
+      /**
+       * Tax ID verification information.
+       */
+      verification: TaxId.Verification | null;
+    }
+
+    namespace TaxId {
+      interface Owner {
+        /**
+         * The account being referenced when `type` is `account`.
+         */
+        account?: string | Stripe.Account;
+
+        /**
+         * The Connect Application being referenced when `type` is `application`.
+         */
+        application?: string | Stripe.Application;
+
+        /**
+         * The customer being referenced when `type` is `customer`.
+         */
+        customer?: string | Stripe.Customer;
+
+        /**
+         * The Account representing the customer being referenced when `type` is `customer`.
+         */
+        customer_account: string | null;
+
+        /**
+         * Type of owner referenced.
+         */
+        type: Owner.Type;
+      }
+
+      namespace Owner {
+        type Type = 'account' | 'application' | 'customer' | 'self';
+      }
+
+      type Type =
+        | 'ad_nrt'
+        | 'ae_trn'
+        | 'al_tin'
+        | 'am_tin'
+        | 'ao_tin'
+        | 'ar_cuit'
+        | 'au_abn'
+        | 'au_arn'
+        | 'aw_tin'
+        | 'az_tin'
+        | 'ba_tin'
+        | 'bb_tin'
+        | 'bd_bin'
+        | 'bf_ifu'
+        | 'bg_uic'
+        | 'bh_vat'
+        | 'bj_ifu'
+        | 'bo_tin'
+        | 'br_cnpj'
+        | 'br_cpf'
+        | 'bs_tin'
+        | 'by_tin'
+        | 'ca_bn'
+        | 'ca_gst_hst'
+        | 'ca_pst_bc'
+        | 'ca_pst_mb'
+        | 'ca_pst_sk'
+        | 'ca_qst'
+        | 'cd_nif'
+        | 'ch_uid'
+        | 'ch_vat'
+        | 'cl_tin'
+        | 'cm_niu'
+        | 'cn_tin'
+        | 'co_nit'
+        | 'cr_tin'
+        | 'cv_nif'
+        | 'de_stn'
+        | 'do_rcn'
+        | 'ec_ruc'
+        | 'eg_tin'
+        | 'es_cif'
+        | 'et_tin'
+        | 'eu_oss_vat'
+        | 'eu_vat'
+        | 'gb_vat'
+        | 'ge_vat'
+        | 'gn_nif'
+        | 'hk_br'
+        | 'hr_oib'
+        | 'hu_tin'
+        | 'id_npwp'
+        | 'il_vat'
+        | 'in_gst'
+        | 'is_vat'
+        | 'jp_cn'
+        | 'jp_rn'
+        | 'jp_trn'
+        | 'ke_pin'
+        | 'kg_tin'
+        | 'kh_tin'
+        | 'kr_brn'
+        | 'kz_bin'
+        | 'la_tin'
+        | 'li_uid'
+        | 'li_vat'
+        | 'lk_vat'
+        | 'ma_vat'
+        | 'md_vat'
+        | 'me_pib'
+        | 'mk_vat'
+        | 'mr_nif'
+        | 'mx_rfc'
+        | 'my_frp'
+        | 'my_itn'
+        | 'my_sst'
+        | 'ng_tin'
+        | 'no_vat'
+        | 'no_voec'
+        | 'np_pan'
+        | 'nz_gst'
+        | 'om_vat'
+        | 'pe_ruc'
+        | 'ph_tin'
+        | 'pl_nip'
+        | 'ro_tin'
+        | 'rs_pib'
+        | 'ru_inn'
+        | 'ru_kpp'
+        | 'sa_vat'
+        | 'sg_gst'
+        | 'sg_uen'
+        | 'si_tin'
+        | 'sn_ninea'
+        | 'sr_fin'
+        | 'sv_nit'
+        | 'th_vat'
+        | 'tj_tin'
+        | 'tr_tin'
+        | 'tw_vat'
+        | 'tz_vat'
+        | 'ua_vat'
+        | 'ug_tin'
+        | 'unknown'
+        | 'us_ein'
+        | 'uy_ruc'
+        | 'uz_tin'
+        | 'uz_vat'
+        | 've_rif'
+        | 'vn_tin'
+        | 'za_vat'
+        | 'zm_tin'
+        | 'zw_tin';
+
+      interface Verification {
+        /**
+         * Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.
+         */
+        status: Verification.Status;
+
+        /**
+         * Verified address.
+         */
+        verified_address: string | null;
+
+        /**
+         * Verified name.
+         */
+        verified_name: string | null;
+      }
+
+      namespace Verification {
+        type Status = 'pending' | 'unavailable' | 'unverified' | 'verified';
+      }
+    }
+  }
+}