chore(docs): Generated References (automated) (#10866)
Generated the following references: - `auth` - `auth_provider` - `core_flows` - `fulfillment` - `fulfillment_provider` - `js_sdk` - `medusa` - `modules` - `modules_sdk` - `order` - `payment` - `stock_location_next` - `stock_location_next_models` - `types` - `utils` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and 
GitHub committed
1 parent
ff3df907ce
commit
5216ad2f15
383 files changed
+244711
-238059
No files matched your search
+33
@@ -0,0 +1,33 @@
|
||||
---
|
||||
displayed_sidebar: stockLocationNextReference
|
||||
slug: /references/stock-location-next/deleteStockLocationAddresses
|
||||
sidebar_label: deleteStockLocationAddresses
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# deleteStockLocationAddresses - Stock Location Next Module Reference
|
||||
|
||||
This documentation provides a reference to the `deleteStockLocationAddresses` method. This belongs to the Stock Location Next Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method deletes a stock location address by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
await stockLocationModuleService.deleteStockLocationAddresses("sla_123")
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string` \\| `string`[]","description":"The ID of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../interfaces/stock_location_next.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/stock_location_next.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":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteStockLocationAddresses"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Resolves when the stock location address is deleted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteStockLocationAddresses"/>
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: stockLocationNextReference
|
||||
slug: /references/stock-location-next/listStockLocationAddresses
|
||||
sidebar_label: listStockLocationAddresses
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# listStockLocationAddresses - Stock Location Next Module Reference
|
||||
|
||||
This documentation provides a reference to the `listStockLocationAddresses` method. This belongs to the Stock Location Next Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of stock location addresses based on optional filters and configuration.
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)","description":"The filters to apply on the retrieved stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock location's address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx) \\| [BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](../../../interfaces/stock_location_next.FilterableStockLocationAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock location's address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[StockLocationAddressDTO](../../../types/stock_location_next.StockLocationAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The list of stock location addressess.","expandable":false,"children":[{"name":"StockLocationAddressDTO[]","type":"[StockLocationAddressDTO](../../../types/stock_location_next.StockLocationAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationAddressDTO","type":"`object`","description":"Represents a Stock Location Address","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listStockLocationAddresses"/>
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
---
|
||||
displayed_sidebar: stockLocationNextReference
|
||||
slug: /references/stock-location-next/upsertStockLocationAddresses
|
||||
sidebar_label: upsertStockLocationAddresses
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# upsertStockLocationAddresses - Stock Location Next Module Reference
|
||||
|
||||
This documentation provides a reference to the `upsertStockLocationAddresses` method. This belongs to the Stock Location Next Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method updates or creates stock location addresses
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
{example-code}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[UpsertStockLocationAddressInput](../../../types/stock_location_next.UpsertStockLocationAddressInput/page.mdx)[]","description":"The list of Make all properties in t optional","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"The first line of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the stock location address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"The second line of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"The city of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"The phone of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"The province of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"The postal code of the stock location address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../types/stock_location_next.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/stock_location_next.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/stock_location_next.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":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertStockLocationAddresses"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[StockLocationAddressDTO](../../../types/stock_location_next.StockLocationAddressDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The created or updated stock location address","expandable":false,"children":[{"name":"StockLocationAddressDTO[]","type":"[StockLocationAddressDTO](../../../types/stock_location_next.StockLocationAddressDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"StockLocationAddressDTO","type":"`object`","description":"Represents a Stock Location Address","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="upsertStockLocationAddresses"/>
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
---
|
||||
displayed_sidebar: stockLocationNextReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# FilterableStockLocationAddressProps
|
||||
|
||||
An object used to allow specifying flexible queries with and/or conditions.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock location's address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStockLocationAddressProps](./page.mdx) \\| [BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<[FilterableStockLocationAddressProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock location's address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter stock location's address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../stock_location_next.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to Line truncated
|
||||
+3
@@ -20,11 +20,14 @@ The main service interface for the Stock Location Module.
|
||||
## Methods
|
||||
|
||||
- [createStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.createStockLocations/page.mdx)
|
||||
- [deleteStockLocationAddresses](../../IStockLocationService/methods/stock_location_next.IStockLocationService.deleteStockLocationAddresses/page.mdx)
|
||||
- [deleteStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.deleteStockLocations/page.mdx)
|
||||
- [listAndCountStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.listAndCountStockLocations/page.mdx)
|
||||
- [listStockLocationAddresses](../../IStockLocationService/methods/stock_location_next.IStockLocationService.listStockLocationAddresses/page.mdx)
|
||||
- [listStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.listStockLocations/page.mdx)
|
||||
- [restoreStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.restoreStockLocations/page.mdx)
|
||||
- [retrieveStockLocation](../../IStockLocationService/methods/stock_location_next.IStockLocationService.retrieveStockLocation/page.mdx)
|
||||
- [softDeleteStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.softDeleteStockLocations/page.mdx)
|
||||
- [updateStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.updateStockLocations/page.mdx)
|
||||
- [upsertStockLocationAddresses](../../IStockLocationService/methods/stock_location_next.IStockLocationService.upsertStockLocationAddresses/page.mdx)
|
||||
- [upsertStockLocations](../../IStockLocationService/methods/stock_location_next.IStockLocationService.upsertStockLocations/page.mdx)
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
---
|
||||
displayed_sidebar: stockLocationNextReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# UpsertStockLocationAddressInput
|
||||
|
||||
**UpsertStockLocationAddressInput**: [StockLocationAddressInput](../stock_location_next.StockLocationAddressInput/page.mdx) & `object`
|
||||
Reference in new issue
Block a user