chore(docs): Generated References (#5881)

Generated the following references:
- `EventBusTypes`
- `IPricingModuleService`
- `ModulesSdkTypes`
- `PriceListWorkflow`
- `fulfillment`
- `js_client`
- `medusa`
- `modules`
- `pricing`
- `services`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-12-14 18:28:23 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent fde1e23995
commit 2d127a4c67
272 changed files with 82 additions and 1205 deletions
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Details of the discount condition to create.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminCreateUserRequest
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteCustomerGroupsGroupCustomerBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The resources to remove.
## constructor
The resources to remove.
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeletePriceListPricesPricesReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeletePriceListsPriceListProductsPricesBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteProductCategoriesCategoryProductsBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteProductsFromCollectionReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeletePublishableApiKeySalesChannelsBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteSalesChannelsChannelProductsBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteSalesChannelsChannelStockLocationsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Product types to remove from the tax rates.
## constructor
Product types to remove from the tax rates.
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteTaxRatesTaxRateProductsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteTaxRatesTaxRateShippingOptionsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminDeleteUploadsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Request parameters used to configure and paginate retrieved batch jobs.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure pagination of the retrieved batch jobs.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to configure the pagination of the retrieved product collections.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product collections.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved currencies.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved customer groups.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved customers.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on discounts' rules.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved discounts.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved draft orders.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved gift cards.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved inventory items.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved notes.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved notifications.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved orders.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved price lists.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved products associated with a price list.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product categories.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product tags.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product types.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved products.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminGetProductsVariantsParams
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved regions.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The list of fulfillment options in a region.
## constructor
The list of fulfillment options in a region.
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved reservations.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved sales channels.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter the retrieved shipping options.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved stock locations.
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "`unknown`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how a list of data is paginated.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved tax rates.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters used to filter and configure the pagination of the retrieved product variants.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters used to filter retrieved customers.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on the retrieved orders.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostAnalyticsConfigAnalyticsConfigReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostAnalyticsConfigReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostAuthReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostBatchesReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCollectionsCollectionReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCollectionsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCurrenciesCurrencyReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomerGroupsGroupCustomersBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomerGroupsGroupReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomerGroupsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomersCustomerReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostCustomersReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Fields to create or update a discount condition.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Fields to create or update a discount condition.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDiscountsDiscountConditionsConditionBatchReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDiscountsDiscountDynamicCodesReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDiscountsDiscountReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Details of the discount rule to create.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Parameters that can be used to configure how data is retrieved.
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDiscountsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDraftOrdersDraftOrderLineItemsItemReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDraftOrdersDraftOrderLineItemsReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDraftOrdersDraftOrderReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostDraftOrdersReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostGiftCardsGiftCardReq
## constructor
___
## Properties
<ParameterTypes parameters={[
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminPostGiftCardsReq
## constructor
___
## Properties
<ParameterTypes parameters={[

Some files were not shown because too many files have changed in this diff Show More