chore(docs): Generated References (#8072)
Generated the following references: - `medusa` - `modules` - `order` - `types`
This commit is contained in:
@@ -4587,6 +4587,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteLineItems/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteLineItems"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChangeActions/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChangeActions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChanges/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChanges"
|
||||
@@ -4715,6 +4719,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreLineItems/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreLineItems"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChanges/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChanges"
|
||||
@@ -4807,6 +4815,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteLineItems/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteLineItems"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChangeActions/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChangeActions"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChanges/page.mdx",
|
||||
"pathname": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChanges"
|
||||
@@ -8743,10 +8755,6 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService/page.mdx",
|
||||
"pathname": "/references/types/EventBusTypes/interfaces/types.EventBusTypes.IEventBusService"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.EventHandler/page.mdx",
|
||||
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.EventHandler"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/EventBusTypes/types/types.EventBusTypes.EventMetadata/page.mdx",
|
||||
"pathname": "/references/types/EventBusTypes/types/types.EventBusTypes.EventMetadata"
|
||||
@@ -8848,8 +8856,24 @@ export const filesMap = [
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollection"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionFilters/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionFilters"
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionDeleteResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionDeleteResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateCampaign/page.mdx",
|
||||
@@ -8883,6 +8907,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductCategory/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductCategory"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductTag/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductTag"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductType/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminCreateProductType"
|
||||
@@ -9035,6 +9063,30 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTag"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagDeleteResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagDeleteResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListParams/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagListResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagResponse"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminProductType"
|
||||
@@ -9179,6 +9231,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionListParams/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionListParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionParams/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionResponse/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionResponse"
|
||||
@@ -9223,6 +9279,10 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductCategoryProducts/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductCategoryProducts"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductTag/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductTag"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductType/page.mdx",
|
||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductType"
|
||||
@@ -9808,8 +9868,12 @@ export const filesMap = [
|
||||
"pathname": "/references/types/interfaces/types.BaseCollection"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseCollectionFilters/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseCollectionFilters"
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseCollectionListParams/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseCollectionListParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseCollectionParams/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseCollectionParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseFile/page.mdx",
|
||||
@@ -9827,6 +9891,14 @@ export const filesMap = [
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseProductCategoryParams/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseProductCategoryParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseProductTag/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseProductTag"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseProductTagListParams/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseProductTagListParams"
|
||||
},
|
||||
{
|
||||
"filePath": "/www/apps/resources/references/types/interfaces/types.BaseProductType/page.mdx",
|
||||
"pathname": "/references/types/interfaces/types.BaseProductType"
|
||||
|
||||
@@ -2563,6 +2563,13 @@ export const generatedSidebar = [
|
||||
"title": "deleteLineItems",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"path": "/references/order/deleteOrderChangeActions",
|
||||
"title": "deleteOrderChangeActions",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -2787,6 +2794,13 @@ export const generatedSidebar = [
|
||||
"title": "restoreLineItems",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"path": "/references/order/restoreOrderChangeActions",
|
||||
"title": "restoreOrderChangeActions",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
@@ -2948,6 +2962,13 @@ export const generatedSidebar = [
|
||||
"title": "softDeleteLineItems",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"path": "/references/order/softDeleteOrderChangeActions",
|
||||
"title": "softDeleteOrderChangeActions",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
|
||||
@@ -2189,6 +2189,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/order/deleteLineItems",
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteLineItems/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChangeActions",
|
||||
"newSlug": "/references/order/deleteOrderChangeActions",
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChangeActions/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChanges",
|
||||
"newSlug": "/references/order/deleteOrderChanges",
|
||||
@@ -2349,6 +2354,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/order/restoreLineItems",
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreLineItems/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions",
|
||||
"newSlug": "/references/order/restoreOrderChangeActions",
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChanges",
|
||||
"newSlug": "/references/order/restoreOrderChanges",
|
||||
@@ -2464,6 +2474,11 @@ export const slugChanges = [
|
||||
"newSlug": "/references/order/softDeleteLineItems",
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteLineItems/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChangeActions",
|
||||
"newSlug": "/references/order/softDeleteOrderChangeActions",
|
||||
"filePath": "/www/apps/resources/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChangeActions/page.mdx"
|
||||
},
|
||||
{
|
||||
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChanges",
|
||||
"newSlug": "/references/order/softDeleteOrderChanges",
|
||||
|
||||
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"data","type":"T \\| [MessageBody](../medusa.MessageBody/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pluginOptions","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="SubscriberArgs"/>
|
||||
<TypeList types={[{"name":"data","type":"[MessageBody](../medusa.MessageBody/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pluginOptions","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="SubscriberArgs"/>
|
||||
|
||||
@@ -34,7 +34,8 @@ import { TypeList } from "docs-ui"
|
||||
- [DeleteFileType](../../types/interfaces/types.DeleteFileType/page.mdx)
|
||||
- [UploadStreamDescriptorType](../../types/interfaces/types.UploadStreamDescriptorType/page.mdx)
|
||||
- [BaseCollection](../../types/interfaces/types.BaseCollection/page.mdx)
|
||||
- [BaseCollectionFilters](../../types/interfaces/types.BaseCollectionFilters/page.mdx)
|
||||
- [BaseCollectionParams](../../types/interfaces/types.BaseCollectionParams/page.mdx)
|
||||
- [BaseCollectionListParams](../../types/interfaces/types.BaseCollectionListParams/page.mdx)
|
||||
- [BaseFile](../../types/interfaces/types.BaseFile/page.mdx)
|
||||
- [AdminUpsertGeoZone](../../types/interfaces/types.AdminUpsertGeoZone/page.mdx)
|
||||
- [AdminUpsertFulfillmentSetServiceZoneCountry](../../types/interfaces/types.AdminUpsertFulfillmentSetServiceZoneCountry/page.mdx)
|
||||
@@ -49,6 +50,8 @@ import { TypeList } from "docs-ui"
|
||||
- [BaseProductCategory](../../types/interfaces/types.BaseProductCategory/page.mdx)
|
||||
- [BaseProductCategoryListParams](../../types/interfaces/types.BaseProductCategoryListParams/page.mdx)
|
||||
- [BaseProductCategoryParams](../../types/interfaces/types.BaseProductCategoryParams/page.mdx)
|
||||
- [BaseProductTag](../../types/interfaces/types.BaseProductTag/page.mdx)
|
||||
- [BaseProductTagListParams](../../types/interfaces/types.BaseProductTagListParams/page.mdx)
|
||||
- [BaseProductType](../../types/interfaces/types.BaseProductType/page.mdx)
|
||||
- [ReservationResponse](../../types/interfaces/types.ReservationResponse/page.mdx)
|
||||
- [AdminUpsertStockLocationAddress](../../types/interfaces/types.AdminUpsertStockLocationAddress/page.mdx)
|
||||
|
||||
+47
@@ -0,0 +1,47 @@
|
||||
---
|
||||
displayed_sidebar: orderReference
|
||||
slug: /references/order/deleteOrderChangeActions
|
||||
sidebar_label: deleteOrderChangeActions
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# deleteOrderChangeActions - Order Module Reference
|
||||
|
||||
This documentation provides a reference to the `deleteOrderChangeActions` method. This belongs to the Order Module.
|
||||
|
||||
## deleteOrderChangeActions(actionId, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes {return type} by its ID.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
await orderModuleService.deleteOrderActions(["12345abc", "67890def"]);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"actionId","type":"`string`[]","description":"The list of {summary}","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="deleteOrderChangeActions"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when {summary}","expandable":false,"children":[]}]} sectionTitle="deleteOrderChangeActions"/>
|
||||
|
||||
## deleteOrderChangeActions(actionId, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes {return type} by its ID.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
await orderModuleService.deleteOrderActions("orderActionId");
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"actionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="deleteOrderChangeActions"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when {summary}","expandable":false,"children":[]}]} sectionTitle="deleteOrderChangeActions"/>
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
---
|
||||
displayed_sidebar: orderReference
|
||||
slug: /references/order/restoreOrderChangeActions
|
||||
sidebar_label: restoreOrderChangeActions
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# restoreOrderChangeActions - Order Module Reference
|
||||
|
||||
This documentation provides a reference to the `restoreOrderChangeActions` method. This belongs to the Order Module.
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"actionId","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[RestoreReturn](../../../interfaces/order.RestoreReturn/page.mdx)<TReturnableLinkableKeys>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"returnLinkableKeys","type":"TReturnableLinkableKeys[]","description":"An array of strings, each being the ID attribute names of the entity's relations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="restoreOrderChangeActions"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void \\| Record<string, string[]>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"void \\| Record<string, string[]>","type":"`void` \\| `Record<string, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="restoreOrderChangeActions"/>
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: orderReference
|
||||
slug: /references/order/softDeleteOrderChangeActions
|
||||
sidebar_label: softDeleteOrderChangeActions
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# softDeleteOrderChangeActions - Order Module Reference
|
||||
|
||||
This documentation provides a reference to the `softDeleteOrderChangeActions` method. This belongs to the Order Module.
|
||||
|
||||
This method deletes {return type} by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
await orderModuleService.softDeleteOrderChangeActions("orderActionId");
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"actionIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[SoftDeleteReturn](../../../interfaces/order.SoftDeleteReturn/page.mdx)<TReturnableLinkableKeys>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"returnLinkableKeys","type":"TReturnableLinkableKeys[]","description":"An array of strings, each being the ID attribute names of the entity's relations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/order.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="softDeleteOrderChangeActions"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void \\| Record<TReturnableLinkableKeys, string[]>>","optional":false,"defaultValue":"","description":"Resolves when {summary}","expandable":false,"children":[{"name":"void \\| Record<TReturnableLinkableKeys, string[]>","type":"`void` \\| `Record<TReturnableLinkableKeys, string[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="softDeleteOrderChangeActions"/>
|
||||
@@ -71,6 +71,9 @@ This section of the documentation provides a reference to the `IOrderModuleServi
|
||||
- [restoreOrderChanges](../../IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChanges/page.mdx)
|
||||
- [applyPendingOrderActions](../../IOrderModuleService/methods/order.IOrderModuleService.applyPendingOrderActions/page.mdx)
|
||||
- [addOrderAction](../../IOrderModuleService/methods/order.IOrderModuleService.addOrderAction/page.mdx)
|
||||
- [deleteOrderChangeActions](../../IOrderModuleService/methods/order.IOrderModuleService.deleteOrderChangeActions/page.mdx)
|
||||
- [softDeleteOrderChangeActions](../../IOrderModuleService/methods/order.IOrderModuleService.softDeleteOrderChangeActions/page.mdx)
|
||||
- [restoreOrderChangeActions](../../IOrderModuleService/methods/order.IOrderModuleService.restoreOrderChangeActions/page.mdx)
|
||||
- [softDeleteAddresses](../../IOrderModuleService/methods/order.IOrderModuleService.softDeleteAddresses/page.mdx)
|
||||
- [restoreAddresses](../../IOrderModuleService/methods/order.IOrderModuleService.restoreAddresses/page.mdx)
|
||||
- [softDeleteLineItems](../../IOrderModuleService/methods/order.IOrderModuleService.softDeleteLineItems/page.mdx)
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# EventHandler
|
||||
|
||||
**EventHandler**: (`data`: TData, `eventName`: `string`) => Promise<void>
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="EventHandler"/>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
+2
-2
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# Subscriber
|
||||
|
||||
**Subscriber**: (`data`: TData, `eventName`: `string`) => Promise<void>
|
||||
**Subscriber**: (`data`: [MessageBody](../types.EventBusTypes.MessageBody/page.mdx)<TData>) => Promise<void>
|
||||
|
||||
## Type Parameters
|
||||
|
||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"data","type":"[MessageBody](../types.EventBusTypes.MessageBody/page.mdx)<TData>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../types.EventBusTypes.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCollection"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCollection"/>
|
||||
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCollectionDeleteResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"collection\"`","description":"The type of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`object`","description":"The parent resource of the item that was deleted, if applicable.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCollectionDeleteResponse"/>
|
||||
-9
File diff suppressed because one or more lines are too long
+9
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCollectionListResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"collections","type":"[AdminCollection](../types.HttpTypes.AdminCollection/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCollectionListResponse"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCollectionParams
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCollectionParams"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCollectionResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"collection","type":"[AdminCollection](../types.HttpTypes.AdminCollection/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminCollectionResponse"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCreateProductTag
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCreateProductTag"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminProductTag
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminProductTag"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminProductTagDeleteResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"product_tag\"`","description":"The type of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`object`","description":"The parent resource of the item that was deleted, if applicable.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminProductTagDeleteResponse"/>
|
||||
+9
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminProductTagListResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"[AdminProductTag](../types.HttpTypes.AdminProductTag/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminProductTagListResponse"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminProductTagParams
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminProductTagParams"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminProductTagResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"product_tag","type":"[AdminProductTag](../types.HttpTypes.AdminProductTag/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminProductTagResponse"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminProductType"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminProductType"/>
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[AdminProductType](../types.HttpTypes.AdminProductType/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminProductTypeListResponse"/>
|
||||
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[AdminProductType](../types.HttpTypes.AdminProductType/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminProductTypeListResponse"/>
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"product_type","type":"[AdminProductType](../types.HttpTypes.AdminProductType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminProductTypeResponse"/>
|
||||
<TypeList types={[{"name":"product_type","type":"[AdminProductType](../types.HttpTypes.AdminProductType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminProductTypeResponse"/>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"tax_rate","type":"[AdminTaxRate](../types.HttpTypes.AdminTaxRate/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"[AdminTaxRate](../types.HttpTypes.AdminTaxRate/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"[AdminTaxRegion](../types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminTaxRateRule](../types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminTaxRateResponse"/>
|
||||
<TypeList types={[{"name":"tax_rate","type":"[AdminTaxRate](../types.HttpTypes.AdminTaxRate/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"[AdminTaxRate](../types.HttpTypes.AdminTaxRate/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`null` \\| [AdminTaxRegion](../types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"[AdminTaxRegion](../types.HttpTypes.AdminTaxRegion/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[AdminTaxRateRule](../types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminTaxRateResponse"/>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+3
-1
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminTaxRegionParams
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminTaxRegionParams"/>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminUpdateProductTag
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"value","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminUpdateProductTag"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminCreateTaxRateRule](../../../interfaces/types.AdminCreateTaxRateRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminUpdateTaxRate"/>
|
||||
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminCreateTaxRateRule](../../../interfaces/types.AdminCreateTaxRateRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminUpdateTaxRate"/>
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="StoreCollection"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="StoreCollection"/>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseCollection"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseCollection"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# BaseCollectionParams
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseCollectionParams"/>
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# BaseProductTag
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseProductTag"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseProductType"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseProductType"/>
|
||||
|
||||
@@ -12,7 +12,6 @@ import { TypeList } from "docs-ui"
|
||||
- [Subscriber](../EventBusTypes/types/types.EventBusTypes.Subscriber/page.mdx)
|
||||
- [SubscriberContext](../EventBusTypes/types/types.EventBusTypes.SubscriberContext/page.mdx)
|
||||
- [SubscriberDescriptor](../EventBusTypes/types/types.EventBusTypes.SubscriberDescriptor/page.mdx)
|
||||
- [EventHandler](../EventBusTypes/types/types.EventBusTypes.EventHandler/page.mdx)
|
||||
- [EventMetadata](../EventBusTypes/types/types.EventBusTypes.EventMetadata/page.mdx)
|
||||
- [MessageBody](../EventBusTypes/types/types.EventBusTypes.MessageBody/page.mdx)
|
||||
- [Message](../EventBusTypes/types/types.EventBusTypes.Message/page.mdx)
|
||||
|
||||
@@ -9,10 +9,14 @@ import { TypeList } from "docs-ui"
|
||||
- [CampaignResponse](../HttpTypes/interfaces/types.HttpTypes.CampaignResponse/page.mdx)
|
||||
- [AdminCampaignResponse](../HttpTypes/interfaces/types.HttpTypes.AdminCampaignResponse/page.mdx)
|
||||
- [AdminCollection](../HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)
|
||||
- [AdminCollectionFilters](../HttpTypes/interfaces/types.HttpTypes.AdminCollectionFilters/page.mdx)
|
||||
- [AdminCreateCollection](../HttpTypes/interfaces/types.HttpTypes.AdminCreateCollection/page.mdx)
|
||||
- [AdminUpdateCollection](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollection/page.mdx)
|
||||
- [AdminUpdateCollectionProducts](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollectionProducts/page.mdx)
|
||||
- [AdminCollectionListParams](../HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx)
|
||||
- [AdminCollectionParams](../HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx)
|
||||
- [AdminCollectionResponse](../HttpTypes/interfaces/types.HttpTypes.AdminCollectionResponse/page.mdx)
|
||||
- [AdminCollectionListResponse](../HttpTypes/interfaces/types.HttpTypes.AdminCollectionListResponse/page.mdx)
|
||||
- [AdminCollectionDeleteResponse](../HttpTypes/interfaces/types.HttpTypes.AdminCollectionDeleteResponse/page.mdx)
|
||||
- [StoreCollection](../HttpTypes/interfaces/types.HttpTypes.StoreCollection/page.mdx)
|
||||
- [StoreCollectionFilters](../HttpTypes/interfaces/types.HttpTypes.StoreCollectionFilters/page.mdx)
|
||||
- [SelectParams](../HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)
|
||||
@@ -64,6 +68,14 @@ import { TypeList } from "docs-ui"
|
||||
- [AdminProductCategoryResponse](../HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryResponse/page.mdx)
|
||||
- [AdminProductCategoryListResponse](../HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryListResponse/page.mdx)
|
||||
- [AdminProductCategoryDeleteResponse](../HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryDeleteResponse/page.mdx)
|
||||
- [AdminProductTag](../HttpTypes/interfaces/types.HttpTypes.AdminProductTag/page.mdx)
|
||||
- [AdminCreateProductTag](../HttpTypes/interfaces/types.HttpTypes.AdminCreateProductTag/page.mdx)
|
||||
- [AdminUpdateProductTag](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductTag/page.mdx)
|
||||
- [AdminProductTagListParams](../HttpTypes/interfaces/types.HttpTypes.AdminProductTagListParams/page.mdx)
|
||||
- [AdminProductTagParams](../HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx)
|
||||
- [AdminProductTagResponse](../HttpTypes/interfaces/types.HttpTypes.AdminProductTagResponse/page.mdx)
|
||||
- [AdminProductTagListResponse](../HttpTypes/interfaces/types.HttpTypes.AdminProductTagListResponse/page.mdx)
|
||||
- [AdminProductTagDeleteResponse](../HttpTypes/interfaces/types.HttpTypes.AdminProductTagDeleteResponse/page.mdx)
|
||||
- [AdminProductType](../HttpTypes/interfaces/types.HttpTypes.AdminProductType/page.mdx)
|
||||
- [AdminCreateProductType](../HttpTypes/interfaces/types.HttpTypes.AdminCreateProductType/page.mdx)
|
||||
- [AdminUpdateProductType](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateProductType/page.mdx)
|
||||
@@ -118,6 +130,7 @@ import { TypeList } from "docs-ui"
|
||||
- [AdminTaxRegion](../HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)
|
||||
- [AdminCreateTaxRegion](../HttpTypes/interfaces/types.HttpTypes.AdminCreateTaxRegion/page.mdx)
|
||||
- [AdminTaxRegionListParams](../HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionListParams/page.mdx)
|
||||
- [AdminTaxRegionParams](../HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionParams/page.mdx)
|
||||
- [AdminTaxRegionResponse](../HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionResponse/page.mdx)
|
||||
- [AdminTaxRegionDeleteResponse](../HttpTypes/interfaces/types.HttpTypes.AdminTaxRegionDeleteResponse/page.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user