class Stripe::TaxIdsApi

Defined in:

stripe/api/tax_ids_api.cr

Constant Summary

DELETE_TAX_IDS_ID_MAX_LENGTH_FOR_ID = 5000
GET_TAX_IDS_ID_MAX_LENGTH_FOR_ID = 5000
GET_TAX_IDS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_TAX_IDS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
POST_TAX_IDS_MAX_LENGTH_FOR__TYPE = 5000
POST_TAX_IDS_VALID_VALUES_FOR__TYPE = String.static_array("ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hr_oib", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat")

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_delete_tax_ids_id(*, id : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_ids(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_tax_ids_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_tax_ids(*, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete_tax_ids_id(*, id : String | Nil = nil) : Stripe::DeletedTaxId #

Deletes an existing account or customer tax_id object.

@required @param id [String?] @return [Stripe::DeletedTaxId]

[View source]
def delete_tax_ids_id(*, id : String | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Deletes an existing account or customer <code>tax_id</code> object.</p> @required @param id [String?] @return nil


[View source]
def delete_tax_ids_id_with_http_info(*, id : String | Nil = nil) : Tuple(Stripe::DeletedTaxId, Int32, Hash(String, Array(String) | String)) #

<p>Deletes an existing account or customer <code>tax_id</code> object.</p> @required @param id [String?] @return [Tuple(Stripe::DeletedTaxId, Integer, Hash)] Stripe::DeletedTaxId, response status code and response headers


[View source]
def get_tax_ids(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil) : Stripe::TaxIDsList #

Returns a list of tax IDs.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param owner [Stripe::OwnerParams?] The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. @return [Stripe::TaxIDsList]

[View source]
def get_tax_ids(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of tax IDs.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param owner [Stripe::OwnerParams?] The account or customer the tax ID belongs to. Defaults to owner[type]=self. @return nil


[View source]
def get_tax_ids_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::TaxId #

Retrieves an account or customer tax_id object.

@required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::TaxId]

[View source]
def get_tax_ids_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves an account or customer <code>tax_id</code> object.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_tax_ids_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::TaxId, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves an account or customer <code>tax_id</code> object.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::TaxId, Integer, Hash)] Stripe::TaxId, response status code and response headers


[View source]
def get_tax_ids_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil) : Tuple(Stripe::TaxIDsList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of tax IDs.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param owner [Stripe::OwnerParams?] The account or customer the tax ID belongs to. Defaults to owner[type]=self. @return [Tuple(Stripe::TaxIDsList, Integer, Hash)] Stripe::TaxIDsList, response status code and response headers


[View source]
def post_tax_ids(*, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil) : Stripe::TaxId #

Creates a new account or customer tax_id object.

@required @param _type [String?] Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` @required @param value [String?] Value of the tax ID. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param owner [Stripe::OwnerParams?] @return [Stripe::TaxId]

[View source]
def post_tax_ids(*, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Creates a new account or customer <code>tax_id</code> object.</p> @required @param _type [String?] Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat @required @param value [String?] Value of the tax ID. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param owner [Stripe::OwnerParams?] @return nil


[View source]
def post_tax_ids_with_http_info(*, _type : String | Nil = nil, value : String | Nil = nil, expand : Array(String) | Nil = nil, owner : Stripe::OwnerParams | Nil = nil) : Tuple(Stripe::TaxId, Int32, Hash(String, Array(String) | String)) #

<p>Creates a new account or customer <code>tax_id</code> object.</p> @required @param _type [String?] Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat @required @param value [String?] Value of the tax ID. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param owner [Stripe::OwnerParams?] @return [Tuple(Stripe::TaxId, Integer, Hash)] Stripe::TaxId, response status code and response headers


[View source]