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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-10 10:35:17 +02:00
committed by GitHub
parent dda886a77f
commit 557352cdfe
90 changed files with 684 additions and 549 deletions

View File

@@ -31,7 +31,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L47)
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/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/0b0d50b47/packages/medusa-js/src/typings.ts#L45)
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L45)

View File

@@ -61,4 +61,4 @@ medusa/dist/api/routes/admin/order-edits/index.d.ts:5
#### Defined in
medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:61
medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:70

View File

@@ -2,7 +2,6 @@
## Classes
- [AdminGetProductTypesPaginationParams](../classes/internal-17.AdminGetProductTypesPaginationParams.md)
- [AdminGetProductTypesParams](../classes/internal-17.AdminGetProductTypesParams.md)
## Type Aliases

View File

@@ -15,7 +15,7 @@
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L31)
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L31)
___
@@ -25,7 +25,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L41)
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L41)
___
@@ -67,7 +67,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L28)
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L28)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L25)
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L25)
___
@@ -93,7 +93,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L23)
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L23)
___
@@ -103,7 +103,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L39)
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L39)
___
@@ -113,4 +113,4 @@ ___
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L37)
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L37)

View File

@@ -2,30 +2,14 @@
## Classes
- [StoreGetVariantsParams](../classes/internal-40.StoreGetVariantsParams.md)
- [StoreGetProductTypesParams](../classes/internal-40.StoreGetProductTypesParams.md)
## Type Aliases
### StoreVariantsListRes
### StoreProductTypesListRes
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreVariantsRes
Ƭ **StoreVariantsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:6
medusa/dist/api/routes/store/product-types/index.d.ts:9

View File

@@ -2,52 +2,30 @@
## Classes
- [StoreGetProductsPaginationParams](../classes/internal-41.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-41.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-41.StorePostSearchReq.md)
- [StoreGetVariantsParams](../classes/internal-41.StoreGetVariantsParams.md)
## Type Aliases
### StorePostSearchRes
### StoreVariantsListRes
Ƭ **StorePostSearchRes**: `Object`
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Index signature
#### Defined in
▪ [k: `string`]: `unknown`
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreVariantsRes
Ƭ **StoreVariantsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `hits` | `unknown`[] |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
#### Defined in
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
medusa/dist/api/routes/store/variants/index.d.ts:6

View File

@@ -1,33 +1,53 @@
# Namespace: internal
## Classes
- [StoreGetProductsPaginationParams](../classes/internal-42.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-42.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-42.StorePostSearchReq.md)
## Type Aliases
### StoreRegionsListRes
### StorePostSearchRes
Ƭ **StoreRegionsListRes**: `Object`
Ƭ **StorePostSearchRes**: `Object`
#### Index signature
▪ [k: `string`]: `unknown`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
| `hits` | `unknown`[] |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:4
medusa/dist/api/routes/store/products/index.d.ts:12
___
### StoreRegionsRes
### StoreProductsListRes
Ƭ **StoreRegionsRes**: `Object`
Ƭ **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 |
| :------ | :------ |
| `region` | [`Region`](../classes/internal.Region.md) |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:7
medusa/dist/api/routes/store/products/index.d.ts:9

View File

@@ -2,32 +2,32 @@
## Type Aliases
### StoreReturnReasonsListRes
### StoreRegionsListRes
Ƭ **StoreReturnReasonsListRes**: `Object`
Ƭ **StoreRegionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:6
medusa/dist/api/routes/store/regions/index.d.ts:4
___
### StoreReturnReasonsRes
### StoreRegionsRes
Ƭ **StoreReturnReasonsRes**: `Object`
Ƭ **StoreRegionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
| `region` | [`Region`](../classes/internal.Region.md) |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:9
medusa/dist/api/routes/store/regions/index.d.ts:7

View File

@@ -1,23 +1,33 @@
# Namespace: internal
## Classes
- [Item](../classes/internal-44.Item.md)
- [ReturnShipping](../classes/internal-44.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-44.StorePostReturnsReq.md)
## Type Aliases
### StoreReturnsRes
### StoreReturnReasonsListRes
Ƭ **StoreReturnsRes**: `Object`
Ƭ **StoreReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/store/returns/index.d.ts:4
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

View File

@@ -2,20 +2,22 @@
## Classes
- [StoreGetShippingOptionsParams](../classes/internal-45.StoreGetShippingOptionsParams.md)
- [Item](../classes/internal-45.Item.md)
- [ReturnShipping](../classes/internal-45.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-45.StorePostReturnsReq.md)
## Type Aliases
### StoreShippingOptionsListRes
### StoreReturnsRes
Ƭ **StoreShippingOptionsListRes**: `Object`
Ƭ **StoreReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/store/shipping-options/index.d.ts:4
medusa/dist/api/routes/store/returns/index.d.ts:4

View File

@@ -2,22 +2,20 @@
## Classes
- [AdditionalItem](../classes/internal-46.AdditionalItem.md)
- [Item](../classes/internal-46.Item.md)
- [StorePostSwapsReq](../classes/internal-46.StorePostSwapsReq.md)
- [StoreGetShippingOptionsParams](../classes/internal-46.StoreGetShippingOptionsParams.md)
## Type Aliases
### StoreSwapsRes
### StoreShippingOptionsListRes
Ƭ **StoreSwapsRes**: `Object`
Ƭ **StoreShippingOptionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
#### Defined in
medusa/dist/api/routes/store/swaps/index.d.ts:7
medusa/dist/api/routes/store/shipping-options/index.d.ts:4

View File

@@ -0,0 +1,23 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-47.AdditionalItem.md)
- [Item](../classes/internal-47.Item.md)
- [StorePostSwapsReq](../classes/internal-47.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

View File

@@ -169,7 +169,7 @@ ___
#### Defined in
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/request.ts#L21)
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L21)
___
@@ -185,7 +185,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L17)
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/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/0b0d50b47/packages/medusa-js/src/typings.ts#L21)
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L21)
___