asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated JS Client Reference (automated) (#2660)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-28 11:02:11 +02:00
committed by GitHub
co-authored by olivermrbl
parent 3cee0bc8fc
commit ee14155eb7
238 changed files with 2768 additions and 1718 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/js-client/modules/internal-10.md
+2 -2
View File
@@ -31,7 +31,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L47)
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L47)
___
@@ -41,4 +41,4 @@ ___
#### Defined in
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L45)
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L45)
docs/content/references/js-client/modules/internal-15.md
+11 -40
View File
@@ -2,68 +2,39 @@
## Classes
- [AdminDeletePriceListPricesPricesReq](../classes/internal-15.AdminDeletePriceListPricesPricesReq.md)
- [AdminGetPriceListPaginationParams](../classes/internal-15.AdminGetPriceListPaginationParams.md)
- [AdminGetPriceListsPriceListProductsParams](../classes/internal-15.AdminGetPriceListsPriceListProductsParams.md)
- [AdminPostPriceListPricesPricesReq](../classes/internal-15.AdminPostPriceListPricesPricesReq.md)
- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md)
- [AdminPostPriceListsPriceListReq](../classes/internal-15.AdminPostPriceListsPriceListReq.md)
- [AdminPriceListPricesCreateReq](../classes/internal-15.AdminPriceListPricesCreateReq.md)
- [AdminPriceListPricesUpdateReq](../classes/internal-15.AdminPriceListPricesUpdateReq.md)
- [CustomerGroup](../classes/internal-15.CustomerGroup.md)
- [CustomerGroup](../classes/internal-15.CustomerGroup-1.md)
- [FilterablePriceListProps](../classes/internal-15.FilterablePriceListProps.md)
- [AdminUpdatePaymentCollectionRequest](../classes/internal-15.AdminUpdatePaymentCollectionRequest.md)
- [GetPaymentCollectionsParams](../classes/internal-15.GetPaymentCollectionsParams.md)
## Type Aliases
### AdminPriceListDeleteBatchRes
### AdminPaymentCollectionDeleteRes
Ƭ **AdminPriceListDeleteBatchRes**: `Object`
Ƭ **AdminPaymentCollectionDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `ids` | `string`[] |
| `object` | `string` |
| `id` | `string` |
| `object` | ``"payment_collection"`` |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:13
medusa/dist/api/routes/admin/payment-collections/index.d.ts:10
___
### AdminPriceListRes
### AdminPaymentCollectionRes
Ƭ **AdminPriceListRes**: `Object`
Ƭ **AdminPaymentCollectionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `price_list` | [`PriceList`](../classes/internal.PriceList.md) |
| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:10
___
### AdminPriceListsListRes
Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] }
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:21
## Variables
### AdminGetPriceListsPriceListProductsParams\_base
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174
medusa/dist/api/routes/admin/payment-collections/index.d.ts:7
docs/content/references/js-client/modules/internal-16.md
+31 -5
View File
@@ -1,16 +1,42 @@
# Namespace: internal
## Enumerations
- [RefundReason](../enums/internal-16.RefundReason.md)
## Classes
- [AdminGetProductTagsPaginationParams](../classes/internal-16.AdminGetProductTagsPaginationParams.md)
- [AdminGetProductTagsParams](../classes/internal-16.AdminGetProductTagsParams.md)
- [AdminPostPaymentRefundsReq](../classes/internal-16.AdminPostPaymentRefundsReq.md)
- [GetPaymentsParams](../classes/internal-16.GetPaymentsParams.md)
## Type Aliases
### AdminProductTagsListRes
### AdminPaymentRes
Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] }
Ƭ **AdminPaymentRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment` | [`Payment`](../classes/internal.Payment.md) |
#### Defined in
medusa/dist/api/routes/admin/product-tags/index.d.ts:9
medusa/dist/api/routes/admin/payments/index.d.ts:6
___
### AdminRefundRes
Ƭ **AdminRefundRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `refund` | [`Refund`](../classes/internal.Refund.md) |
#### Defined in
medusa/dist/api/routes/admin/payments/index.d.ts:9
docs/content/references/js-client/modules/internal-17.md
+58 -4
View File
@@ -2,14 +2,68 @@
## Classes
- [AdminGetProductTypesParams](../classes/internal-17.AdminGetProductTypesParams.md)
- [AdminDeletePriceListPricesPricesReq](../classes/internal-17.AdminDeletePriceListPricesPricesReq.md)
- [AdminGetPriceListPaginationParams](../classes/internal-17.AdminGetPriceListPaginationParams.md)
- [AdminGetPriceListsPriceListProductsParams](../classes/internal-17.AdminGetPriceListsPriceListProductsParams.md)
- [AdminPostPriceListPricesPricesReq](../classes/internal-17.AdminPostPriceListPricesPricesReq.md)
- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md)
- [AdminPostPriceListsPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListReq.md)
- [AdminPriceListPricesCreateReq](../classes/internal-17.AdminPriceListPricesCreateReq.md)
- [AdminPriceListPricesUpdateReq](../classes/internal-17.AdminPriceListPricesUpdateReq.md)
- [CustomerGroup](../classes/internal-17.CustomerGroup.md)
- [CustomerGroup](../classes/internal-17.CustomerGroup-1.md)
- [FilterablePriceListProps](../classes/internal-17.FilterablePriceListProps.md)
## Type Aliases
### AdminProductTypesListRes
### AdminPriceListDeleteBatchRes
Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
Ƭ **AdminPriceListDeleteBatchRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `ids` | `string`[] |
| `object` | `string` |
#### Defined in
medusa/dist/api/routes/admin/product-types/index.d.ts:9
medusa/dist/api/routes/admin/price-lists/index.d.ts:13
___
### AdminPriceListRes
Ƭ **AdminPriceListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `price_list` | [`PriceList`](../classes/internal.PriceList.md) |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:10
___
### AdminPriceListsListRes
Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] }
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:21
## Variables
### AdminGetPriceListsPriceListProductsParams\_base
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174
docs/content/references/js-client/modules/internal-18.md
+5 -200
View File
@@ -2,210 +2,15 @@
## Classes
- [AdminGetProductsParams](../classes/internal-18.AdminGetProductsParams.md)
- [AdminPostProductsProductMetadataReq](../classes/internal-18.AdminPostProductsProductMetadataReq.md)
- [AdminPostProductsProductOptionsOption](../classes/internal-18.AdminPostProductsProductOptionsOption.md)
- [AdminPostProductsProductOptionsReq](../classes/internal-18.AdminPostProductsProductOptionsReq.md)
- [AdminPostProductsProductReq](../classes/internal-18.AdminPostProductsProductReq.md)
- [AdminPostProductsProductVariantsReq](../classes/internal-18.AdminPostProductsProductVariantsReq.md)
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-18.AdminPostProductsProductVariantsVariantReq.md)
- [AdminPostProductsReq](../classes/internal-18.AdminPostProductsReq.md)
- [FilterableProductProps](../classes/internal-18.FilterableProductProps.md)
- [ProductOptionReq](../classes/internal-18.ProductOptionReq.md)
- [ProductSalesChannelReq](../classes/internal-18.ProductSalesChannelReq.md)
- [ProductTagReq](../classes/internal-18.ProductTagReq.md)
- [ProductTypeReq](../classes/internal-18.ProductTypeReq.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-1.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-2.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-3.md)
- [ProductVariantPricesCreateReq](../classes/internal-18.ProductVariantPricesCreateReq.md)
- [ProductVariantPricesUpdateReq](../classes/internal-18.ProductVariantPricesUpdateReq.md)
- [ProductVariantReq](../classes/internal-18.ProductVariantReq.md)
- [ProductVariantReq](../classes/internal-18.ProductVariantReq-1.md)
- [AdminGetProductTagsPaginationParams](../classes/internal-18.AdminGetProductTagsPaginationParams.md)
- [AdminGetProductTagsParams](../classes/internal-18.AdminGetProductTagsParams.md)
## Type Aliases
### AdminProductsDeleteOptionRes
### AdminProductTagsListRes
Ƭ **AdminProductsDeleteOptionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"option"`` |
| `option_id` | `string` |
| `product` | [`Product`](../classes/internal.Product.md) |
Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:13
___
### AdminProductsDeleteRes
Ƭ **AdminProductsDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"product"`` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:25
___
### AdminProductsDeleteVariantRes
Ƭ **AdminProductsDeleteVariantRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"product-variant"`` |
| `product` | [`Product`](../classes/internal.Product.md) |
| `variant_id` | `string` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:19
___
### AdminProductsListRes
Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-18.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:30
___
### AdminProductsListTagsRes
Ƭ **AdminProductsListTagsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:36
___
### AdminProductsListTypesRes
Ƭ **AdminProductsListTypesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `types` | [`ProductType`](../classes/internal.ProductType.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:33
___
### AdminProductsRes
Ƭ **AdminProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:39
___
### PricedProduct
Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-18.md#pricedvariant)[] }
#### Defined in
medusa/dist/types/pricing.d.ts:31
___
### PricedVariant
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-18.md#productvariantpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:30
___
### ProductVariantPricing
Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-18.md#taxedpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:4
___
### TaxServiceRate
Ƭ **TaxServiceRate**: `Object`
The tax rate object as configured in Medusa. These may have an unspecified
numerical rate as they may be used for lookup purposes in the tax provider
plugin.
#### Type declaration
| Name | Type |
| :------ | :------ |
| `code` | `string` \| ``null`` |
| `name` | `string` |
| `rate?` | `number` \| ``null`` |
#### Defined in
medusa/dist/types/tax-service.d.ts:6
___
### TaxedPricing
Ƭ **TaxedPricing**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `calculated_price_incl_tax` | `number` \| ``null`` |
| `calculated_tax` | `number` \| ``null`` |
| `original_price_incl_tax` | `number` \| ``null`` |
| `original_tax` | `number` \| ``null`` |
| `tax_rates` | [`TaxServiceRate`](internal-18.md#taxservicerate)[] \| ``null`` |
#### Defined in
medusa/dist/types/pricing.d.ts:12
medusa/dist/api/routes/admin/product-tags/index.d.ts:9
docs/content/references/js-client/modules/internal-19.md
+4 -13
View File
@@ -2,23 +2,14 @@
## Classes
- [AdminGetRegionsPaginationParams](../classes/internal-19.AdminGetRegionsPaginationParams.md)
- [AdminGetRegionsParams](../classes/internal-19.AdminGetRegionsParams.md)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)
- [AdminPostRegionsRegionCountriesReq](../classes/internal-19.AdminPostRegionsRegionCountriesReq.md)
- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md)
- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md)
- [AdminPostRegionsRegionReq](../classes/internal-19.AdminPostRegionsRegionReq.md)
- [AdminPostRegionsReq](../classes/internal-19.AdminPostRegionsReq.md)
- [AdminRegionsRes](../classes/internal-19.AdminRegionsRes.md)
- [FulfillmentOption](../classes/internal-19.FulfillmentOption.md)
- [AdminGetProductTypesParams](../classes/internal-19.AdminGetProductTypesParams.md)
## Type Aliases
### AdminRegionsListRes
### AdminProductTypesListRes
Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] }
Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
#### Defined in
medusa/dist/api/routes/admin/regions/index.d.ts:12
medusa/dist/api/routes/admin/product-types/index.d.ts:9
docs/content/references/js-client/modules/internal-20.md
+183 -10
View File
@@ -2,37 +2,210 @@
## Classes
- [AdminPostReturnReasonsReasonReq](../classes/internal-20.AdminPostReturnReasonsReasonReq.md)
- [AdminPostReturnReasonsReq](../classes/internal-20.AdminPostReturnReasonsReq.md)
- [AdminGetProductsParams](../classes/internal-20.AdminGetProductsParams.md)
- [AdminPostProductsProductMetadataReq](../classes/internal-20.AdminPostProductsProductMetadataReq.md)
- [AdminPostProductsProductOptionsOption](../classes/internal-20.AdminPostProductsProductOptionsOption.md)
- [AdminPostProductsProductOptionsReq](../classes/internal-20.AdminPostProductsProductOptionsReq.md)
- [AdminPostProductsProductReq](../classes/internal-20.AdminPostProductsProductReq.md)
- [AdminPostProductsProductVariantsReq](../classes/internal-20.AdminPostProductsProductVariantsReq.md)
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-20.AdminPostProductsProductVariantsVariantReq.md)
- [AdminPostProductsReq](../classes/internal-20.AdminPostProductsReq.md)
- [FilterableProductProps](../classes/internal-20.FilterableProductProps.md)
- [ProductOptionReq](../classes/internal-20.ProductOptionReq.md)
- [ProductSalesChannelReq](../classes/internal-20.ProductSalesChannelReq.md)
- [ProductTagReq](../classes/internal-20.ProductTagReq.md)
- [ProductTypeReq](../classes/internal-20.ProductTypeReq.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-1.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-2.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-3.md)
- [ProductVariantPricesCreateReq](../classes/internal-20.ProductVariantPricesCreateReq.md)
- [ProductVariantPricesUpdateReq](../classes/internal-20.ProductVariantPricesUpdateReq.md)
- [ProductVariantReq](../classes/internal-20.ProductVariantReq.md)
- [ProductVariantReq](../classes/internal-20.ProductVariantReq-1.md)
## Type Aliases
### AdminReturnReasonsListRes
### AdminProductsDeleteOptionRes
Ƭ **AdminReturnReasonsListRes**: `Object`
Ƭ **AdminProductsDeleteOptionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
| `deleted` | `boolean` |
| `object` | ``"option"`` |
| `option_id` | `string` |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:10
medusa/dist/api/routes/admin/products/index.d.ts:13
___
### AdminReturnReasonsRes
### AdminProductsDeleteRes
Ƭ **AdminReturnReasonsRes**: `Object`
Ƭ **AdminProductsDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"product"`` |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:7
medusa/dist/api/routes/admin/products/index.d.ts:25
___
### AdminProductsDeleteVariantRes
Ƭ **AdminProductsDeleteVariantRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"product-variant"`` |
| `product` | [`Product`](../classes/internal.Product.md) |
| `variant_id` | `string` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:19
___
### AdminProductsListRes
Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-20.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:30
___
### AdminProductsListTagsRes
Ƭ **AdminProductsListTagsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:36
___
### AdminProductsListTypesRes
Ƭ **AdminProductsListTypesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `types` | [`ProductType`](../classes/internal.ProductType.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:33
___
### AdminProductsRes
Ƭ **AdminProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:39
___
### PricedProduct
Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] }
#### Defined in
medusa/dist/types/pricing.d.ts:31
___
### PricedVariant
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-20.md#productvariantpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:30
___
### ProductVariantPricing
Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-20.md#taxedpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:4
___
### TaxServiceRate
Ƭ **TaxServiceRate**: `Object`
The tax rate object as configured in Medusa. These may have an unspecified
numerical rate as they may be used for lookup purposes in the tax provider
plugin.
#### Type declaration
| Name | Type |
| :------ | :------ |
| `code` | `string` \| ``null`` |
| `name` | `string` |
| `rate?` | `number` \| ``null`` |
#### Defined in
medusa/dist/types/tax-service.d.ts:15
___
### TaxedPricing
Ƭ **TaxedPricing**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `calculated_price_incl_tax` | `number` \| ``null`` |
| `calculated_tax` | `number` \| ``null`` |
| `original_price_incl_tax` | `number` \| ``null`` |
| `original_tax` | `number` \| ``null`` |
| `tax_rates` | [`TaxServiceRate`](internal-20.md#taxservicerate)[] \| ``null`` |
#### Defined in
medusa/dist/types/pricing.d.ts:12
docs/content/references/js-client/modules/internal-21.md
+22 -27
View File
@@ -2,48 +2,43 @@
## Classes
- [AdminGetReturnsParams](../classes/internal-21.AdminGetReturnsParams.md)
- [AdminPostReturnsReturnReceiveReq](../classes/internal-21.AdminPostReturnsReturnReceiveReq.md)
- [Item](../classes/internal-21.Item.md)
- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md)
- [AdminPostPublishableApiKeysReq](../classes/internal-21.AdminPostPublishableApiKeysReq.md)
- [GetPublishableApiKeysParams](../classes/internal-21.GetPublishableApiKeysParams.md)
- [PublishableApiKey](../classes/internal-21.PublishableApiKey.md)
## Type Aliases
### AdminReturnsCancelRes
### AdminPublishableApiKeysListRes
Ƭ **AdminReturnsCancelRes**: `Object`
Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md)[] }
#### Defined in
medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:8
___
### AdminPublishableApiKeysRes
Ƭ **AdminPublishableApiKeysRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
| `publishable_api_key` | [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md) |
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:6
medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:5
___
## Variables
### AdminReturnsListRes
### GetPublishableApiKeysParams\_base
Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] }
• `Const` **GetPublishableApiKeysParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:9
___
### AdminReturnsRes
Ƭ **AdminReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:12
medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:60
docs/content/references/js-client/modules/internal-22.md
+13 -35
View File
@@ -2,45 +2,23 @@
## Classes
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md)
- [AdminGetSalesChannelsParams](../classes/internal-22.AdminGetSalesChannelsParams.md)
- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md)
- [AdminPostSalesChannelsReq](../classes/internal-22.AdminPostSalesChannelsReq.md)
- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md)
- [ProductBatchSalesChannel](../classes/internal-22.ProductBatchSalesChannel.md)
- [AdminGetRegionsPaginationParams](../classes/internal-22.AdminGetRegionsPaginationParams.md)
- [AdminGetRegionsParams](../classes/internal-22.AdminGetRegionsParams.md)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)
- [AdminPostRegionsRegionCountriesReq](../classes/internal-22.AdminPostRegionsRegionCountriesReq.md)
- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md)
- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md)
- [AdminPostRegionsRegionReq](../classes/internal-22.AdminPostRegionsRegionReq.md)
- [AdminPostRegionsReq](../classes/internal-22.AdminPostRegionsReq.md)
- [AdminRegionsRes](../classes/internal-22.AdminRegionsRes.md)
- [FulfillmentOption](../classes/internal-22.FulfillmentOption.md)
## Type Aliases
### AdminSalesChannelsListRes
### AdminRegionsListRes
Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] }
Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] }
#### Defined in
medusa/dist/api/routes/admin/sales-channels/index.d.ts:10
___
### AdminSalesChannelsRes
Ƭ **AdminSalesChannelsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) |
#### Defined in
medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
## Variables
### AdminGetSalesChannelsParams\_base
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141
medusa/dist/api/routes/admin/regions/index.d.ts:12
docs/content/references/js-client/modules/internal-23.md
+22 -19
View File
@@ -2,34 +2,37 @@
## Classes
- [AdminGetShippingOptionsParams](../classes/internal-23.AdminGetShippingOptionsParams.md)
- [AdminPostShippingOptionsOptionReq](../classes/internal-23.AdminPostShippingOptionsOptionReq.md)
- [AdminPostShippingOptionsReq](../classes/internal-23.AdminPostShippingOptionsReq.md)
- [OptionRequirement](../classes/internal-23.OptionRequirement.md)
- [OptionRequirement](../classes/internal-23.OptionRequirement-1.md)
- [AdminPostReturnReasonsReasonReq](../classes/internal-23.AdminPostReturnReasonsReasonReq.md)
- [AdminPostReturnReasonsReq](../classes/internal-23.AdminPostReturnReasonsReq.md)
## Type Aliases
### AdminShippingOptionsListRes
### AdminReturnReasonsListRes
Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] }
#### Defined in
medusa/dist/api/routes/admin/shipping-options/index.d.ts:8
___
### AdminShippingOptionsRes
Ƭ **AdminShippingOptionsRes**: `Object`
Ƭ **AdminReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/admin/shipping-options/index.d.ts:11
medusa/dist/api/routes/admin/return-reasons/index.d.ts:10
___
### AdminReturnReasonsRes
Ƭ **AdminReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:7
docs/content/references/js-client/modules/internal-24.md
+21 -10
View File
@@ -2,37 +2,48 @@
## Classes
- [AdminPostShippingProfilesProfileReq](../classes/internal-24.AdminPostShippingProfilesProfileReq.md)
- [AdminPostShippingProfilesReq](../classes/internal-24.AdminPostShippingProfilesReq.md)
- [AdminGetReturnsParams](../classes/internal-24.AdminGetReturnsParams.md)
- [AdminPostReturnsReturnReceiveReq](../classes/internal-24.AdminPostReturnsReturnReceiveReq.md)
- [Item](../classes/internal-24.Item.md)
## Type Aliases
### AdminShippingProfilesListRes
### AdminReturnsCancelRes
Ƭ **AdminShippingProfilesListRes**: `Object`
Ƭ **AdminReturnsCancelRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12
medusa/dist/api/routes/admin/returns/index.d.ts:6
___
### AdminShippingProfilesRes
### AdminReturnsListRes
Ƭ **AdminShippingProfilesRes**: `Object`
Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] }
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:9
___
### AdminReturnsRes
Ƭ **AdminReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9
medusa/dist/api/routes/admin/returns/index.d.ts:12
docs/content/references/js-client/modules/internal-25.md
+17 -25
View File
@@ -2,53 +2,45 @@
## Classes
- [AdminPostStoreReq](../classes/internal-25.AdminPostStoreReq.md)
- [Store](../classes/internal-25.Store.md)
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md)
- [AdminGetSalesChannelsParams](../classes/internal-25.AdminGetSalesChannelsParams.md)
- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md)
- [AdminPostSalesChannelsReq](../classes/internal-25.AdminPostSalesChannelsReq.md)
- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md)
- [ProductBatchSalesChannel](../classes/internal-25.ProductBatchSalesChannel.md)
## Type Aliases
### AdminPaymentProvidersList
### AdminSalesChannelsListRes
Ƭ **AdminPaymentProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] |
Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] }
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:10
medusa/dist/api/routes/admin/sales-channels/index.d.ts:10
___
### AdminStoresRes
### AdminSalesChannelsRes
Ƭ **AdminStoresRes**: `Object`
Ƭ **AdminSalesChannelsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `store` | [`Store`](../classes/internal-25.Store.md) |
| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:4
medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
___
## Variables
### AdminTaxProvidersList
### AdminGetSalesChannelsParams\_base
Ƭ **AdminTaxProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] |
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:7
medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141
docs/content/references/js-client/modules/internal-26.md
+12 -8
View File
@@ -2,30 +2,34 @@
## Classes
- [AdminGetSwapsParams](../classes/internal-26.AdminGetSwapsParams.md)
- [AdminGetShippingOptionsParams](../classes/internal-26.AdminGetShippingOptionsParams.md)
- [AdminPostShippingOptionsOptionReq](../classes/internal-26.AdminPostShippingOptionsOptionReq.md)
- [AdminPostShippingOptionsReq](../classes/internal-26.AdminPostShippingOptionsReq.md)
- [OptionRequirement](../classes/internal-26.OptionRequirement.md)
- [OptionRequirement](../classes/internal-26.OptionRequirement-1.md)
## Type Aliases
### AdminSwapsListRes
### AdminShippingOptionsListRes
Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] }
Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] }
#### Defined in
medusa/dist/api/routes/admin/swaps/index.d.ts:7
medusa/dist/api/routes/admin/shipping-options/index.d.ts:8
___
### AdminSwapsRes
### AdminShippingOptionsRes
Ƭ **AdminSwapsRes**: `Object`
Ƭ **AdminShippingOptionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) |
#### Defined in
medusa/dist/api/routes/admin/swaps/index.d.ts:10
medusa/dist/api/routes/admin/shipping-options/index.d.ts:11
docs/content/references/js-client/modules/internal-27.md
+22 -28
View File
@@ -2,43 +2,37 @@
## Classes
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md)
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md)
- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md)
- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md)
- [AdminGetTaxRatesParams](../classes/internal-27.AdminGetTaxRatesParams.md)
- [AdminGetTaxRatesTaxRateParams](../classes/internal-27.AdminGetTaxRatesTaxRateParams.md)
- [AdminPostTaxRatesReq](../classes/internal-27.AdminPostTaxRatesReq.md)
- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md)
- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md)
- [AdminPostTaxRatesTaxRateReq](../classes/internal-27.AdminPostTaxRatesTaxRateReq.md)
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md)
- [NumericalComparisonOperator](../classes/internal-27.NumericalComparisonOperator.md)
- [AdminPostShippingProfilesProfileReq](../classes/internal-27.AdminPostShippingProfilesProfileReq.md)
- [AdminPostShippingProfilesReq](../classes/internal-27.AdminPostShippingProfilesReq.md)
## Type Aliases
### AdminTaxRatesListRes
### AdminShippingProfilesListRes
Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] }
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:8
___
### AdminTaxRatesRes
Ƭ **AdminTaxRatesRes**: `Object`
Ƭ **AdminShippingProfilesListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) |
| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] |
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:11
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12
___
### AdminShippingProfilesRes
Ƭ **AdminShippingProfilesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9
docs/content/references/js-client/modules/internal-28.md
+26 -11
View File
@@ -2,38 +2,53 @@
## Classes
- [AdminDeleteUploadsReq](../classes/internal-28.AdminDeleteUploadsReq.md)
- [AdminPostUploadsDownloadUrlReq](../classes/internal-28.AdminPostUploadsDownloadUrlReq.md)
- [IAdminPostUploadsFileReq](../classes/internal-28.IAdminPostUploadsFileReq.md)
- [AdminPostStoreReq](../classes/internal-28.AdminPostStoreReq.md)
- [Store](../classes/internal-28.Store.md)
## Type Aliases
### AdminUploadsDownloadUrlRes
### AdminPaymentProvidersList
Ƭ **AdminUploadsDownloadUrlRes**: `Object`
Ƭ **AdminPaymentProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `download_url` | `string` |
| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:10
medusa/dist/api/routes/admin/store/index.d.ts:10
___
### AdminUploadsRes
### AdminStoresRes
Ƭ **AdminUploadsRes**: `Object`
Ƭ **AdminStoresRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `uploads` | { `url`: `string` }[] |
| `store` | [`Store`](../classes/internal-28.Store.md) |
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:4
medusa/dist/api/routes/admin/store/index.d.ts:4
___
### AdminTaxProvidersList
Ƭ **AdminTaxProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:7
docs/content/references/js-client/modules/internal-29.md
+8 -93
View File
@@ -2,115 +2,30 @@
## Classes
- [AdminCreateUserRequest](../classes/internal-29.AdminCreateUserRequest.md)
- [AdminResetPasswordRequest](../classes/internal-29.AdminResetPasswordRequest.md)
- [AdminResetPasswordTokenRequest](../classes/internal-29.AdminResetPasswordTokenRequest.md)
- [AdminUpdateUserRequest](../classes/internal-29.AdminUpdateUserRequest.md)
- [AdminGetSwapsParams](../classes/internal-29.AdminGetSwapsParams.md)
## Type Aliases
### AdminCreateUserPayload
### AdminSwapsListRes
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-29.md#createuserroles) }
Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] }
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L31)
medusa/dist/api/routes/admin/swaps/index.d.ts:7
___
### AdminUpdateUserPayload
### AdminSwapsRes
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-29.md#updateuserroles) }
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L41)
___
### AdminUserRes
Ƭ **AdminUserRes**: `Object`
Ƭ **AdminSwapsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:6
___
### AdminUsersListRes
Ƭ **AdminUsersListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:9
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L37)
medusa/dist/api/routes/admin/swaps/index.d.ts:10
docs/content/references/js-client/modules/internal-30.md
+33 -6
View File
@@ -2,16 +2,43 @@
## Classes
- [AdminGetVariantsParams](../classes/internal-30.AdminGetVariantsParams.md)
- [AdminPriceSelectionParams](../classes/internal-30.AdminPriceSelectionParams.md)
- [PriceSelectionParams](../classes/internal-30.PriceSelectionParams.md)
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md)
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md)
- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md)
- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md)
- [AdminGetTaxRatesParams](../classes/internal-30.AdminGetTaxRatesParams.md)
- [AdminGetTaxRatesTaxRateParams](../classes/internal-30.AdminGetTaxRatesTaxRateParams.md)
- [AdminPostTaxRatesReq](../classes/internal-30.AdminPostTaxRatesReq.md)
- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md)
- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md)
- [AdminPostTaxRatesTaxRateReq](../classes/internal-30.AdminPostTaxRatesTaxRateReq.md)
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md)
- [NumericalComparisonOperator](../classes/internal-30.NumericalComparisonOperator.md)
## Type Aliases
### AdminVariantsListRes
### AdminTaxRatesListRes
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-18.md#pricedvariant)[] }
Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] }
#### Defined in
medusa/dist/api/routes/admin/variants/index.d.ts:10
medusa/dist/api/routes/admin/tax-rates/index.d.ts:8
___
### AdminTaxRatesRes
Ƭ **AdminTaxRatesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) |
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:11
docs/content/references/js-client/modules/internal-31.md
+11 -9
View File
@@ -2,36 +2,38 @@
## Classes
- [StorePostAuthReq](../classes/internal-31.StorePostAuthReq.md)
- [AdminDeleteUploadsReq](../classes/internal-31.AdminDeleteUploadsReq.md)
- [AdminPostUploadsDownloadUrlReq](../classes/internal-31.AdminPostUploadsDownloadUrlReq.md)
- [IAdminPostUploadsFileReq](../classes/internal-31.IAdminPostUploadsFileReq.md)
## Type Aliases
### StoreAuthRes
### AdminUploadsDownloadUrlRes
Ƭ **StoreAuthRes**: `Object`
Ƭ **AdminUploadsDownloadUrlRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
| `download_url` | `string` |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:4
medusa/dist/api/routes/admin/uploads/index.d.ts:10
___
### StoreGetAuthEmailRes
### AdminUploadsRes
Ƭ **StoreGetAuthEmailRes**: `Object`
Ƭ **AdminUploadsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `exists` | `boolean` |
| `uploads` | { `url`: `string` }[] |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:7
medusa/dist/api/routes/admin/uploads/index.d.ts:4
docs/content/references/js-client/modules/internal-32.md
+93 -15
View File
@@ -2,37 +2,115 @@
## Classes
- [Discount](../classes/internal-32.Discount.md)
- [GiftCard](../classes/internal-32.GiftCard.md)
- [Item](../classes/internal-32.Item.md)
- [StorePostCartReq](../classes/internal-32.StorePostCartReq.md)
- [StorePostCartsCartPaymentSessionReq](../classes/internal-32.StorePostCartsCartPaymentSessionReq.md)
- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md)
- [StorePostCartsCartReq](../classes/internal-32.StorePostCartsCartReq.md)
- [StorePostCartsCartShippingMethodReq](../classes/internal-32.StorePostCartsCartShippingMethodReq.md)
- [AdminCreateUserRequest](../classes/internal-32.AdminCreateUserRequest.md)
- [AdminResetPasswordRequest](../classes/internal-32.AdminResetPasswordRequest.md)
- [AdminResetPasswordTokenRequest](../classes/internal-32.AdminResetPasswordTokenRequest.md)
- [AdminUpdateUserRequest](../classes/internal-32.AdminUpdateUserRequest.md)
## Type Aliases
### StoreCartsRes
### AdminCreateUserPayload
Ƭ **StoreCartsRes**: `Object`
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-32.md#createuserroles) }
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L31)
___
### AdminUpdateUserPayload
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-32.md#updateuserroles) }
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L41)
___
### AdminUserRes
Ƭ **AdminUserRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:8
medusa/dist/api/routes/admin/users/index.d.ts:6
___
### StoreCompleteCartRes
### AdminUsersListRes
Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` }
Ƭ **AdminUsersListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:11
medusa/dist/api/routes/admin/users/index.d.ts:9
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L37)
docs/content/references/js-client/modules/internal-33.md
+6 -20
View File
@@ -2,30 +2,16 @@
## Classes
- [StoreGetCollectionsParams](../classes/internal-33.StoreGetCollectionsParams.md)
- [AdminGetVariantsParams](../classes/internal-33.AdminGetVariantsParams.md)
- [AdminPriceSelectionParams](../classes/internal-33.AdminPriceSelectionParams.md)
- [PriceSelectionParams](../classes/internal-33.PriceSelectionParams.md)
## Type Aliases
### StoreCollectionsListRes
### AdminVariantsListRes
Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] }
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:7
___
### StoreCollectionsRes
Ƭ **StoreCollectionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:10
medusa/dist/api/routes/admin/variants/index.d.ts:10
docs/content/references/js-client/modules/internal-34.md
+26 -9
View File
@@ -2,19 +2,36 @@
## Classes
- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md)
- [StoreGetCustomersCustomerOrdersParams](../classes/internal-34.StoreGetCustomersCustomerOrdersParams.md)
- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md)
- [StorePostCustomersCustomerReq](../classes/internal-34.StorePostCustomersCustomerReq.md)
- [StorePostCustomersReq](../classes/internal-34.StorePostCustomersReq.md)
- [StorePostCustomersResetPasswordReq](../classes/internal-34.StorePostCustomersResetPasswordReq.md)
- [StorePostAuthReq](../classes/internal-34.StorePostAuthReq.md)
## Type Aliases
### StoreCustomersListOrdersRes
### StoreAuthRes
Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
Ƭ **StoreAuthRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:12
medusa/dist/api/routes/store/auth/index.d.ts:4
___
### StoreGetAuthEmailRes
Ƭ **StoreGetAuthEmailRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `exists` | `boolean` |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:7
docs/content/references/js-client/modules/internal-35.md
+25 -4
View File
@@ -1,17 +1,38 @@
# Namespace: internal
## Classes
- [Discount](../classes/internal-35.Discount.md)
- [GiftCard](../classes/internal-35.GiftCard.md)
- [Item](../classes/internal-35.Item.md)
- [StorePostCartReq](../classes/internal-35.StorePostCartReq.md)
- [StorePostCartsCartPaymentSessionReq](../classes/internal-35.StorePostCartsCartPaymentSessionReq.md)
- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md)
- [StorePostCartsCartReq](../classes/internal-35.StorePostCartsCartReq.md)
- [StorePostCartsCartShippingMethodReq](../classes/internal-35.StorePostCartsCartShippingMethodReq.md)
## Type Aliases
### StoreGiftCardsRes
### StoreCartsRes
Ƭ **StoreGiftCardsRes**: `Object`
Ƭ **StoreCartsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> |
#### Defined in
medusa/dist/api/routes/store/gift-cards/index.d.ts:8
medusa/dist/api/routes/store/carts/index.d.ts:8
___
### StoreCompleteCartRes
Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` }
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:11
docs/content/references/js-client/modules/internal-36.md
+27 -2
View File
@@ -2,5 +2,30 @@
## Classes
- [StorePostCartsCartLineItemsItemReq](../classes/internal-36.StorePostCartsCartLineItemsItemReq.md)
- [StorePostCartsCartLineItemsReq](../classes/internal-36.StorePostCartsCartLineItemsReq.md)
- [StoreGetCollectionsParams](../classes/internal-36.StoreGetCollectionsParams.md)
## Type Aliases
### StoreCollectionsListRes
Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:7
___
### StoreCollectionsRes
Ƭ **StoreCollectionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:10
docs/content/references/js-client/modules/internal-37.md
+9 -10
View File
@@ -2,20 +2,19 @@
## Classes
- [StorePostOrderEditsOrderEditDecline](../classes/internal-37.StorePostOrderEditsOrderEditDecline.md)
- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md)
- [StoreGetCustomersCustomerOrdersParams](../classes/internal-37.StoreGetCustomersCustomerOrdersParams.md)
- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md)
- [StorePostCustomersCustomerReq](../classes/internal-37.StorePostCustomersCustomerReq.md)
- [StorePostCustomersReq](../classes/internal-37.StorePostCustomersReq.md)
- [StorePostCustomersResetPasswordReq](../classes/internal-37.StorePostCustomersResetPasswordReq.md)
## Type Aliases
### StoreOrderEditsRes
### StoreCustomersListOrdersRes
Ƭ **StoreOrderEditsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> |
Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
#### Defined in
medusa/dist/api/routes/store/order-edits/index.d.ts:4
medusa/dist/api/routes/store/customers/index.d.ts:12
docs/content/references/js-client/modules/internal-38.md
+4 -9
View File
@@ -1,22 +1,17 @@
# Namespace: internal
## Classes
- [ShippingAddressPayload](../classes/internal-38.ShippingAddressPayload.md)
- [StoreGetOrdersParams](../classes/internal-38.StoreGetOrdersParams.md)
## Type Aliases
### StoreOrdersRes
### StoreGiftCardsRes
Ƭ **StoreOrdersRes**: `Object`
Ƭ **StoreGiftCardsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
#### Defined in
medusa/dist/api/routes/store/orders/index.d.ts:9
medusa/dist/api/routes/store/gift-cards/index.d.ts:8
docs/content/references/js-client/modules/internal-39.md
+3 -14
View File
@@ -1,17 +1,6 @@
# Namespace: internal
## Type Aliases
## Classes
### StoreCustomersListPaymentMethodsRes
Ƭ **StoreCustomersListPaymentMethodsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:15
- [StorePostCartsCartLineItemsItemReq](../classes/internal-39.StorePostCartsCartLineItemsItemReq.md)
- [StorePostCartsCartLineItemsReq](../classes/internal-39.StorePostCartsCartLineItemsReq.md)
docs/content/references/js-client/modules/internal-40.md
+10 -4
View File
@@ -2,14 +2,20 @@
## Classes
- [StoreGetProductTypesParams](../classes/internal-40.StoreGetProductTypesParams.md)
- [StorePostOrderEditsOrderEditDecline](../classes/internal-40.StorePostOrderEditsOrderEditDecline.md)
## Type Aliases
### StoreProductTypesListRes
### StoreOrderEditsRes
Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
Ƭ **StoreOrderEditsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> |
#### Defined in
medusa/dist/api/routes/store/product-types/index.d.ts:9
medusa/dist/api/routes/store/order-edits/index.d.ts:4
docs/content/references/js-client/modules/internal-41.md
+6 -15
View File
@@ -2,30 +2,21 @@
## Classes
- [StoreGetVariantsParams](../classes/internal-41.StoreGetVariantsParams.md)
- [ShippingAddressPayload](../classes/internal-41.ShippingAddressPayload.md)
- [StoreGetOrdersParams](../classes/internal-41.StoreGetOrdersParams.md)
## Type Aliases
### StoreVariantsListRes
### StoreOrdersRes
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreVariantsRes
Ƭ **StoreVariantsRes**: `Object`
Ƭ **StoreOrdersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:6
medusa/dist/api/routes/store/orders/index.d.ts:9
docs/content/references/js-client/modules/internal-42.md
+11 -25
View File
@@ -2,52 +2,38 @@
## Classes
- [StoreGetProductsPaginationParams](../classes/internal-42.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-42.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-42.StorePostSearchReq.md)
- [PaymentCollectionSessionInputRequest](../classes/internal-42.PaymentCollectionSessionInputRequest.md)
- [StoreManagePaymentCollectionSessionRequest](../classes/internal-42.StoreManagePaymentCollectionSessionRequest.md)
- [StoreRefreshPaymentCollectionSessionRequest](../classes/internal-42.StoreRefreshPaymentCollectionSessionRequest.md)
## Type Aliases
### StorePostSearchRes
### StorePaymentCollectionRes
Ƭ **StorePostSearchRes**: `Object`
#### Index signature
▪ [k: `string`]: `unknown`
Ƭ **StorePaymentCollectionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `hits` | `unknown`[] |
| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:12
medusa/dist/api/routes/store/payment-collections/index.d.ts:7
___
### StoreProductsListRes
### StorePaymentCollectionSessionRes
Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] }
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:16
___
### StoreProductsRes
Ƭ **StoreProductsRes**: `Object`
Ƭ **StorePaymentCollectionSessionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
| `payment_session` | [`PaymentSession`](../classes/internal.PaymentSession.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:9
medusa/dist/api/routes/store/payment-collections/index.d.ts:10
docs/content/references/js-client/modules/internal-43.md
+4 -20
View File
@@ -2,32 +2,16 @@
## Type Aliases
### StoreRegionsListRes
### StoreCustomersListPaymentMethodsRes
Ƭ **StoreRegionsListRes**: `Object`
Ƭ **StoreCustomersListPaymentMethodsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:4
___
### StoreRegionsRes
Ƭ **StoreRegionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `region` | [`Region`](../classes/internal.Region.md) |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:7
medusa/dist/api/routes/store/customers/index.d.ts:15
docs/content/references/js-client/modules/internal-44.md
+7 -25
View File
@@ -1,33 +1,15 @@
# Namespace: internal
## Classes
- [StoreGetProductTypesParams](../classes/internal-44.StoreGetProductTypesParams.md)
## Type Aliases
### StoreReturnReasonsListRes
### StoreProductTypesListRes
Ƭ **StoreReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:6
___
### StoreReturnReasonsRes
Ƭ **StoreReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:9
medusa/dist/api/routes/store/product-types/index.d.ts:9
docs/content/references/js-client/modules/internal-45.md
+15 -7
View File
@@ -2,22 +2,30 @@
## Classes
- [Item](../classes/internal-45.Item.md)
- [ReturnShipping](../classes/internal-45.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-45.StorePostReturnsReq.md)
- [StoreGetVariantsParams](../classes/internal-45.StoreGetVariantsParams.md)
## Type Aliases
### StoreReturnsRes
### StoreVariantsListRes
Ƭ **StoreReturnsRes**: `Object`
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreVariantsRes
Ƭ **StoreVariantsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
#### Defined in
medusa/dist/api/routes/store/returns/index.d.ts:4
medusa/dist/api/routes/store/variants/index.d.ts:6
docs/content/references/js-client/modules/internal-46.md
+37 -5
View File
@@ -2,20 +2,52 @@
## Classes
- [StoreGetShippingOptionsParams](../classes/internal-46.StoreGetShippingOptionsParams.md)
- [StoreGetProductsPaginationParams](../classes/internal-46.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-46.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-46.StorePostSearchReq.md)
## Type Aliases
### StoreShippingOptionsListRes
### StorePostSearchRes
Ƭ **StoreShippingOptionsListRes**: `Object`
Ƭ **StorePostSearchRes**: `Object`
#### Index signature
▪ [k: `string`]: `unknown`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
| `hits` | `unknown`[] |
#### Defined in
medusa/dist/api/routes/store/shipping-options/index.d.ts:4
medusa/dist/api/routes/store/products/index.d.ts:12
___
### StoreProductsListRes
Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] }
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:16
___
### StoreProductsRes
Ƭ **StoreProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:9
docs/content/references/js-client/modules/internal-47.md
+20 -10
View File
@@ -1,23 +1,33 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-47.AdditionalItem.md)
- [Item](../classes/internal-47.Item.md)
- [StorePostSwapsReq](../classes/internal-47.StorePostSwapsReq.md)
## Type Aliases
### StoreSwapsRes
### StoreRegionsListRes
Ƭ **StoreSwapsRes**: `Object`
Ƭ **StoreRegionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
#### Defined in
medusa/dist/api/routes/store/swaps/index.d.ts:7
medusa/dist/api/routes/store/regions/index.d.ts:4
___
### StoreRegionsRes
Ƭ **StoreRegionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `region` | [`Region`](../classes/internal.Region.md) |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:7
docs/content/references/js-client/modules/internal-48.md
+33
View File
@@ -0,0 +1,33 @@
# Namespace: internal
## Type Aliases
### StoreReturnReasonsListRes
Ƭ **StoreReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:6
___
### StoreReturnReasonsRes
Ƭ **StoreReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:9
docs/content/references/js-client/modules/internal-49.md
+23
View File
@@ -0,0 +1,23 @@
# Namespace: internal
## Classes
- [Item](../classes/internal-49.Item.md)
- [ReturnShipping](../classes/internal-49.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-49.StorePostReturnsReq.md)
## Type Aliases
### StoreReturnsRes
Ƭ **StoreReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/store/returns/index.d.ts:4
docs/content/references/js-client/modules/internal-50.md
+21
View File
@@ -0,0 +1,21 @@
# Namespace: internal
## Classes
- [StoreGetShippingOptionsParams](../classes/internal-50.StoreGetShippingOptionsParams.md)
## Type Aliases
### StoreShippingOptionsListRes
Ƭ **StoreShippingOptionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
#### Defined in
medusa/dist/api/routes/store/shipping-options/index.d.ts:4
docs/content/references/js-client/modules/internal-51.md
+23
View File
@@ -0,0 +1,23 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-51.AdditionalItem.md)
- [Item](../classes/internal-51.Item.md)
- [StorePostSwapsReq](../classes/internal-51.StorePostSwapsReq.md)
## Type Aliases
### StoreSwapsRes
Ƭ **StoreSwapsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
#### Defined in
medusa/dist/api/routes/store/swaps/index.d.ts:7
docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md
+41 -1
View File
@@ -29,6 +29,8 @@ ___
| Name | Type |
| :------ | :------ |
| `featureFlags` | `Record`<`string`, `boolean` \| `string`\> |
| `moduleResolutions?` | `Record`<`string`, [`ModuleResolution`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduleresolution)\> |
| `modules?` | `Record`<`string`, `string`\> |
| `plugins` | ({ `options`: `Record`<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] |
| `projectConfig` | { `admin_cors?`: `string` ; `cookie_secret?`: `string` ; `database_database?`: `string` ; `database_extra?`: `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } ; `database_logging`: `LoggerOptions` ; `database_type`: `string` ; `database_url?`: `string` ; `jwt_secret?`: `string` ; `redis_url?`: `string` ; `store_cors?`: `string` } |
| `projectConfig.admin_cors?` | `string` |
@@ -44,7 +46,7 @@ ___
#### Defined in
medusa/dist/types/global.d.ts:38
medusa/dist/types/global.d.ts:50
___
@@ -81,3 +83,41 @@ ___
#### Defined in
medusa/dist/types/global.d.ts:30
___
### ModuleDefinition
Ƭ **ModuleDefinition**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `canOverride?` | `boolean` |
| `defaultPackage` | `string` |
| `isRequired?` | `boolean` |
| `key` | `string` |
| `label` | `string` |
| `registrationName` | `string` |
#### Defined in
medusa/dist/types/global.d.ts:42
___
### ModuleResolution
Ƭ **ModuleResolution**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `definition` | [`ModuleDefinition`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduledefinition) |
| `resolutionPath` | `string` |
#### Defined in
medusa/dist/types/global.d.ts:38
docs/content/references/js-client/modules/internal.md
+4 -4
View File
@@ -129,7 +129,7 @@ displayed_sidebar: jsClientSidebar
#### Defined in
medusa/dist/models/payment-collection.d.ts:16
medusa/dist/models/payment-collection.d.ts:11
## Type Aliases
@@ -169,7 +169,7 @@ ___
#### Defined in
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L21)
[medusa-js/src/request.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L26)
___
@@ -185,7 +185,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L17)
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L17)
___
@@ -201,7 +201,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L21)
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L21)
___