Class: AdminTaxRatesResource
Hierarchy
defaultCopy to Clipboard↳
AdminTaxRatesResourceCopy to Clipboard
Methods
addProductTypes
▸ addProductTypes(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostTaxRatesTaxRateProductTypesReqCopy to Clipboard |
query?Copy to Clipboard | AdminGetTaxRatesTaxRateParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:100
addProducts
▸ addProducts(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostTaxRatesTaxRateProductsReqCopy to Clipboard |
query?Copy to Clipboard | AdminGetTaxRatesTaxRateParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:84
addShippingOptions
▸ addShippingOptions(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostTaxRatesTaxRateShippingOptionsReqCopy to Clipboard |
query?Copy to Clipboard | AdminGetTaxRatesTaxRateParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:116
create
▸ create(payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostTaxRatesReqCopy to Clipboard |
query?Copy to Clipboard | AdminGetTaxRatesTaxRateParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:53
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:180
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetTaxRatesParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:39
removeProductTypes
▸ removeProductTypes(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminDeleteTaxRatesTaxRateProductTypesReqCopy to Clipboard |
query?Copy to Clipboard | AdminDeleteTaxRatesTaxRateProductTypesParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:148
removeProducts
▸ removeProducts(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminDeleteTaxRatesTaxRateProductsReqCopy to Clipboard |
query?Copy to Clipboard | AdminDeleteTaxRatesTaxRateProductsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:132
removeShippingOptions
▸ removeShippingOptions(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminDeleteTaxRatesTaxRateShippingOptionsReqCopy to Clipboard |
query?Copy to Clipboard | AdminDeleteTaxRatesTaxRateShippingOptionsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:164
retrieve
▸ retrieve(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | AdminGetTaxRatesTaxRateParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/tax-rates.ts:24
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostTaxRatesTaxRateReqCopy to Clipboard |
query?Copy to Clipboard | AdminGetTaxRatesTaxRateParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxRatesResCopy to Clipboard>