chore(docs): Generated References (#5516)
Generated the following references: - `js-client` - `pricing` - `services` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
Oli Juhl
Shahed Nasser
Oli Juhl
Shahed Nasser
parent
80fe362f33
commit
aa2bb7a31b
+15
@@ -0,0 +1,15 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CacheTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).CacheTypes
|
||||
|
||||
## References
|
||||
|
||||
### ICacheService
|
||||
|
||||
Re-exports [ICacheService](../../internal/interfaces/admin_discounts.internal.ICacheService.mdx)
|
||||
+503
@@ -0,0 +1,503 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CommonTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).CommonTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [AddressCreatePayload](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.AddressCreatePayload.mdx)
|
||||
- [AddressPayload](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.AddressPayload.mdx)
|
||||
- [BaseEntity](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.BaseEntity.mdx)
|
||||
- [CustomFindOptions](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.CustomFindOptions.mdx)
|
||||
- [DateComparisonOperator](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.DateComparisonOperator.mdx)
|
||||
- [EmptyQueryParams](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.EmptyQueryParams.mdx)
|
||||
- [FindConfig](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)
|
||||
- [FindPaginationParams](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindPaginationParams.mdx)
|
||||
- [FindParams](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindParams.mdx)
|
||||
- [NumericalComparisonOperator](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.NumericalComparisonOperator.mdx)
|
||||
- [RepositoryTransformOptions](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)
|
||||
- [SoftDeletableEntity](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.SoftDeletableEntity.mdx)
|
||||
- [StringComparisonOperator](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.StringComparisonOperator.mdx)
|
||||
|
||||
## References
|
||||
|
||||
### ConfigModule
|
||||
|
||||
Re-exports [ConfigModule](../../admin_discounts/modules/admin_discounts.internal.mdx#configmodule)
|
||||
|
||||
___
|
||||
|
||||
### DeleteResponse
|
||||
|
||||
Re-exports [DeleteResponse](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse)
|
||||
|
||||
___
|
||||
|
||||
### MedusaContainer
|
||||
|
||||
Re-exports [MedusaContainer](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer)
|
||||
|
||||
___
|
||||
|
||||
### PaginatedResponse
|
||||
|
||||
Re-exports [PaginatedResponse](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### ExtendedFindConfig
|
||||
|
||||
**ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TEntity",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### HttpCompressionOptions
|
||||
|
||||
**HttpCompressionOptions**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "enabled",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "level",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "memLevel",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "threshold",
|
||||
"type": "`number` \\| `string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### PartialPick
|
||||
|
||||
**PartialPick**<`T`, `K`\>: { [P in K]?: T[P] }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "K",
|
||||
"type": "keyof `T`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ProjectConfigOptions
|
||||
|
||||
**ProjectConfigOptions**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "admin_cors",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "cookie_secret",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database_database",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database_extra",
|
||||
"type": "Record<`string`, `unknown`\\> & { `ssl`: { `rejectUnauthorized`: ``false`` } }",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database_logging",
|
||||
"type": "`LoggerOptions`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database_schema",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database_type",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database_url",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "http_compression",
|
||||
"type": "[`HttpCompressionOptions`](admin_discounts.internal.internal-1.CommonTypes.mdx#httpcompressionoptions)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "jwt_secret",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "redis_options",
|
||||
"type": "`RedisOptions`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "redis_prefix",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "redis_url",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "session_options",
|
||||
"type": "[`SessionOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#sessionoptions)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "store_cors",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### QueryConfig
|
||||
|
||||
**QueryConfig**<`TEntity`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TEntity",
|
||||
"type": "[`BaseEntity`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.BaseEntity.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "allowedFields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "allowedRelations",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultFields",
|
||||
"type": "(keyof `TEntity` \\| `string`)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultLimit",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultRelations",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isList",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### QuerySelector
|
||||
|
||||
**QuerySelector**<`TEntity`\>: [`Selector`](admin_discounts.internal.internal-1.CommonTypes.mdx#selector)<`TEntity`\> & { `q?`: `string` }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TEntity",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### RequestQueryFields
|
||||
|
||||
**RequestQueryFields**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "expand",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "fields",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "offset",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### Selector
|
||||
|
||||
**Selector**<`TEntity`\>: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator<TEntity[key][] \| string \| string[]\\> }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TEntity",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### TotalField
|
||||
|
||||
**TotalField**: ``"shipping_total"`` \| ``"discount_total"`` \| ``"tax_total"`` \| ``"refunded_total"`` \| ``"total"`` \| ``"subtotal"`` \| ``"refundable_amount"`` \| ``"gift_card_total"`` \| ``"gift_card_tax_total"``
|
||||
|
||||
___
|
||||
|
||||
### TreeQuerySelector
|
||||
|
||||
**TreeQuerySelector**<`TEntity`\>: [`QuerySelector`](admin_discounts.internal.internal-1.CommonTypes.mdx#queryselector)<`TEntity`\> & { `include_descendants_tree?`: `boolean` }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TEntity",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### WithRequiredProperty
|
||||
|
||||
**WithRequiredProperty**<`T`, `K`\>: `T` & { [Property in K]-?: T[Property] }
|
||||
|
||||
Utility type used to remove some optional attributes (coming from K) from a type T
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "K",
|
||||
"type": "keyof `T`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### Writable
|
||||
|
||||
**Writable**<`T`\>: { -readonly [key in keyof T]: T[key] \| FindOperator<T[key]\\> \| FindOperator<T[key][]\\> \| FindOperator<string[]\\> }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+97
@@ -0,0 +1,97 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DAL
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).DAL
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [BaseFilterable](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)
|
||||
- [OptionsQuery](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.OptionsQuery.mdx)
|
||||
- [RepositoryService](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.RepositoryService.mdx)
|
||||
- [RestoreReturn](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.RestoreReturn.mdx)
|
||||
- [SoftDeleteReturn](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.SoftDeleteReturn.mdx)
|
||||
- [TreeRepositoryService](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.TreeRepositoryService.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### EntityDateColumns
|
||||
|
||||
**EntityDateColumns**: ``"created_at"`` \| ``"updated_at"``
|
||||
|
||||
___
|
||||
|
||||
### FilterQuery
|
||||
|
||||
**FilterQuery**<`T`, `Prev`\>: `Prev` extends `never` ? `never` : { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]\\> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V\\>, PrevLimit[Prev]\\> : never : never : never }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "Prev",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### FindOptions
|
||||
|
||||
**FindOptions**<`T`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`OptionsQuery`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.OptionsQuery.mdx)<`T`, `any`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "where",
|
||||
"type": "[`FilterQuery`](admin_discounts.internal.internal-1.DAL.mdx#filterquery)<`T`\\> & [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterQuery`](admin_discounts.internal.internal-1.DAL.mdx#filterquery)<`T`\\>\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### SoftDeletableEntityDateColumns
|
||||
|
||||
**SoftDeletableEntityDateColumns**: ``"deleted_at"`` \| [`EntityDateColumns`](admin_discounts.internal.internal-1.DAL.mdx#entitydatecolumns)
|
||||
+125
@@ -0,0 +1,125 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# EventBusTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).EventBusTypes
|
||||
|
||||
## References
|
||||
|
||||
### EmitData
|
||||
|
||||
Re-exports [EmitData](../../admin_discounts/modules/admin_discounts.internal.mdx#emitdata)
|
||||
|
||||
___
|
||||
|
||||
### IEventBusModuleService
|
||||
|
||||
Re-exports [IEventBusModuleService](../../internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx)
|
||||
|
||||
___
|
||||
|
||||
### IEventBusService
|
||||
|
||||
Re-exports [IEventBusService](../../internal/interfaces/admin_discounts.internal.IEventBusService.mdx)
|
||||
|
||||
___
|
||||
|
||||
### Subscriber
|
||||
|
||||
Re-exports [Subscriber](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriber)
|
||||
|
||||
___
|
||||
|
||||
### SubscriberContext
|
||||
|
||||
Re-exports [SubscriberContext](../../admin_discounts/modules/admin_discounts.internal.mdx#subscribercontext)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### EventHandler
|
||||
|
||||
**EventHandler**<`T`\>: (`data`: `T`, `eventName`: `string`) => `Promise`<`void`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
(`data`, `eventName`): `Promise`<`void`\>
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`T`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "eventName",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### SubscriberDescriptor
|
||||
|
||||
**SubscriberDescriptor**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"type": "[`Subscriber`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriber)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+79
@@ -0,0 +1,79 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FeatureFlagTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).FeatureFlagTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [IFlagRouter](../../FeatureFlagTypes/interfaces/admin_discounts.internal.internal-1.FeatureFlagTypes.IFlagRouter.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### FeatureFlagsResponse
|
||||
|
||||
**FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| Record<`string`, `boolean`\> }[]
|
||||
|
||||
#### Schema
|
||||
|
||||
FeatureFlagsResponse
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- key
|
||||
- value
|
||||
properties:
|
||||
key:
|
||||
description: The key of the feature flag.
|
||||
type: string
|
||||
value:
|
||||
description: The value of the feature flag.
|
||||
type: boolean
|
||||
|
||||
___
|
||||
|
||||
### FlagSettings
|
||||
|
||||
**FlagSettings**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "default_val",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "env_key",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+557
@@ -0,0 +1,557 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# InventoryTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).InventoryTypes
|
||||
|
||||
## References
|
||||
|
||||
### IInventoryService
|
||||
|
||||
Re-exports [IInventoryService](../../internal/interfaces/admin_discounts.internal.IInventoryService.mdx)
|
||||
|
||||
___
|
||||
|
||||
### InventoryItemDTO
|
||||
|
||||
Re-exports [InventoryItemDTO](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)
|
||||
|
||||
___
|
||||
|
||||
### InventoryLevelDTO
|
||||
|
||||
Re-exports [InventoryLevelDTO](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)
|
||||
|
||||
___
|
||||
|
||||
### ReservationItemDTO
|
||||
|
||||
Re-exports [ReservationItemDTO](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)
|
||||
|
||||
___
|
||||
|
||||
### ReserveQuantityContext
|
||||
|
||||
Re-exports [ReserveQuantityContext](../../admin_discounts/modules/admin_discounts.internal.mdx#reservequantitycontext)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### BulkUpdateInventoryLevelInput
|
||||
|
||||
**BulkUpdateInventoryLevelInput**: { `inventory_item_id`: `string` ; `location_id`: `string` } & [`UpdateInventoryLevelInput`](admin_discounts.internal.internal-1.InventoryTypes.mdx#updateinventorylevelinput)
|
||||
|
||||
___
|
||||
|
||||
### CreateInventoryItemInput
|
||||
|
||||
**CreateInventoryItemInput**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\> \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "requires_shipping",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### CreateInventoryLevelInput
|
||||
|
||||
**CreateInventoryLevelInput**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "incoming_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_item_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "reserved_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "stocked_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### CreateReservationItemInput
|
||||
|
||||
**CreateReservationItemInput**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_by",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "external_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_item_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "line_item_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\> \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### FilterableInventoryItemProps
|
||||
|
||||
**FilterableInventoryItemProps**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string` \\| `string`[] \\| [`StringComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.StringComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "q",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "requires_shipping",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string` \\| `string`[] \\| [`StringComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.StringComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### FilterableInventoryLevelProps
|
||||
|
||||
**FilterableInventoryLevelProps**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "incoming_quantity",
|
||||
"type": "`number` \\| [`NumericalComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.NumericalComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_item_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "reserved_quantity",
|
||||
"type": "`number` \\| [`NumericalComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.NumericalComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "stocked_quantity",
|
||||
"type": "`number` \\| [`NumericalComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.NumericalComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### FilterableReservationItemProps
|
||||
|
||||
**FilterableReservationItemProps**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_by",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string` \\| [`StringComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.StringComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_item_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "line_item_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "`number` \\| [`NumericalComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.NumericalComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### UpdateInventoryLevelInput
|
||||
|
||||
**UpdateInventoryLevelInput**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "incoming_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "stocked_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### UpdateReservationItemInput
|
||||
|
||||
**UpdateReservationItemInput**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "location_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\> \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# LoggerTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).LoggerTypes
|
||||
|
||||
## References
|
||||
|
||||
### Logger
|
||||
|
||||
Re-exports [Logger](../../internal/interfaces/admin_discounts.internal.Logger.mdx)
|
||||
+617
@@ -0,0 +1,617 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ModulesSdkTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).ModulesSdkTypes
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [MODULE\_RESOURCE\_TYPE](../../ModulesSdkTypes/enums/admin_discounts.internal.internal-1.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx)
|
||||
- [MODULE\_SCOPE](../../ModulesSdkTypes/enums/admin_discounts.internal.internal-1.ModulesSdkTypes.MODULE_SCOPE.mdx)
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [ModuleServiceInitializeOptions](../../ModulesSdkTypes/interfaces/admin_discounts.internal.internal-1.ModulesSdkTypes.ModuleServiceInitializeOptions.mdx)
|
||||
|
||||
## References
|
||||
|
||||
### Constructor
|
||||
|
||||
Re-exports [Constructor](../../admin_discounts/modules/admin_discounts.internal.mdx#constructor)
|
||||
|
||||
___
|
||||
|
||||
### MedusaContainer
|
||||
|
||||
Re-exports [MedusaContainer](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer)
|
||||
|
||||
___
|
||||
|
||||
### RemoteQueryFunction
|
||||
|
||||
Re-exports [RemoteQueryFunction](../../admin_discounts/modules/admin_discounts.internal.mdx#remotequeryfunction)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### ExternalModuleDeclaration
|
||||
|
||||
**ExternalModuleDeclaration**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "alias",
|
||||
"type": "`string`",
|
||||
"description": "If multiple modules are registered with the same key, the alias can be used to differentiate them",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "definition",
|
||||
"type": "[`ModuleDefinition`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduledefinition)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "main",
|
||||
"type": "`boolean`",
|
||||
"description": "If the module is the main module for the key when multiple ones are registered",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "scope",
|
||||
"type": "[`EXTERNAL`](../../ModulesSdkTypes/enums/admin_discounts.internal.internal-1.ModulesSdkTypes.MODULE_SCOPE.mdx#external)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "server",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "server.keepAlive",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "server.type",
|
||||
"type": "``\"http\"``",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "server.url",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### InternalModuleDeclaration
|
||||
|
||||
**InternalModuleDeclaration**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "alias",
|
||||
"type": "`string`",
|
||||
"description": "If multiple modules are registered with the same key, the alias can be used to differentiate them",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "definition",
|
||||
"type": "[`ModuleDefinition`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduledefinition)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "dependencies",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "main",
|
||||
"type": "`boolean`",
|
||||
"description": "If the module is the main module for the key when multiple ones are registered",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "resolve",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "resources",
|
||||
"type": "[`MODULE_RESOURCE_TYPE`](../../ModulesSdkTypes/enums/admin_discounts.internal.internal-1.ModulesSdkTypes.MODULE_RESOURCE_TYPE.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "scope",
|
||||
"type": "[`INTERNAL`](../../ModulesSdkTypes/enums/admin_discounts.internal.internal-1.ModulesSdkTypes.MODULE_SCOPE.mdx#internal)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### LinkModuleDefinition
|
||||
|
||||
**LinkModuleDefinition**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "defaultModuleDeclaration",
|
||||
"type": "[`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "dependencies",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "label",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "registrationName",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### LoadedModule
|
||||
|
||||
**LoadedModule**: `unknown` & { `__definition`: [`ModuleDefinition`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduledefinition) ; `__joinerConfig`: [`ModuleJoinerConfig`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerconfig) }
|
||||
|
||||
___
|
||||
|
||||
### LoaderOptions
|
||||
|
||||
**LoaderOptions**<`TOptions`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TOptions",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "container",
|
||||
"type": "[`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "logger",
|
||||
"type": "[`Logger`](../../internal/interfaces/admin_discounts.internal.Logger.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`TOptions`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### LogLevel
|
||||
|
||||
**LogLevel**: ``"query"`` \| ``"schema"`` \| ``"error"`` \| ``"warn"`` \| ``"info"`` \| ``"log"`` \| ``"migration"``
|
||||
|
||||
___
|
||||
|
||||
### LoggerOptions
|
||||
|
||||
**LoggerOptions**: `boolean` \| ``"all"`` \| [`LogLevel`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#loglevel)[]
|
||||
|
||||
___
|
||||
|
||||
### ModuleConfig
|
||||
|
||||
**ModuleConfig**: [`ModuleDeclaration`](../../admin_discounts/modules/admin_discounts.internal.mdx#moduledeclaration) & { `definition`: [`ModuleDefinition`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduledefinition) ; `module`: `string` ; `path`: `string` }
|
||||
|
||||
___
|
||||
|
||||
### ModuleDefinition
|
||||
|
||||
**ModuleDefinition**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "canOverride",
|
||||
"type": "`boolean`",
|
||||
"description": "#### Deprecated property will be removed in future versions",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultModuleDeclaration",
|
||||
"type": "[`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration) \\| [`ExternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#externalmoduledeclaration)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultPackage",
|
||||
"type": "`string` \\| ``false``",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "dependencies",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isLegacy",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isQueryable",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isRequired",
|
||||
"type": "`boolean`",
|
||||
"description": "#### Deprecated property will be removed in future versions",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "label",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "registrationName",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ModuleExports
|
||||
|
||||
**ModuleExports**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "loaders",
|
||||
"type": "[`ModuleLoaderFunction`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduleloaderfunction)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "migrations",
|
||||
"type": "`any`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "models",
|
||||
"type": "[`Constructor`](../../admin_discounts/modules/admin_discounts.internal.mdx#constructor)<`any`\\>[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "service",
|
||||
"type": "[`Constructor`](../../admin_discounts/modules/admin_discounts.internal.mdx#constructor)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "revertMigration",
|
||||
"type": "(`options`: [`LoaderOptions`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#loaderoptions)<Record<`string`, `unknown`\\>\\>, `moduleDeclaration?`: [`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration)) => `Promise`<`void`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "runMigrations",
|
||||
"type": "(`options`: [`LoaderOptions`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#loaderoptions)<Record<`string`, `unknown`\\>\\>, `moduleDeclaration?`: [`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration)) => `Promise`<`void`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ModuleJoinerConfig
|
||||
|
||||
**ModuleJoinerConfig**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](../interfaces/admin_discounts.internal.internal-1.JoinerServiceConfig.mdx), ``"serviceName"`` \| ``"primaryKeys"`` \| ``"relationships"`` \| ``"extends"``\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\> ; `type`: ``"date"`` \| ``"time"`` \| ``"datetime"`` \| ``"bigint"`` \| ``"blob"`` \| ``"uint8array"`` \| ``"array"`` \| ``"enumArray"`` \| ``"enum"`` \| ``"json"`` \| ``"integer"`` \| ``"smallint"`` \| ``"tinyint"`` \| ``"mediumint"`` \| ``"float"`` \| ``"double"`` \| ``"boolean"`` \| ``"decimal"`` \| ``"string"`` \| ``"uuid"`` \| ``"text"`` }\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> ; `relationship`: [`ModuleJoinerRelationship`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }
|
||||
|
||||
___
|
||||
|
||||
### ModuleJoinerRelationship
|
||||
|
||||
**ModuleJoinerRelationship**: [`JoinerRelationship`](../../internal/modules/admin_discounts.internal.internal-1.mdx#joinerrelationship) & { `deleteCascade?`: `boolean` ; `isInternalService?`: `boolean` }
|
||||
|
||||
___
|
||||
|
||||
### ModuleLoaderFunction
|
||||
|
||||
**ModuleLoaderFunction**: (`options`: [`LoaderOptions`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#loaderoptions), `moduleDeclaration?`: [`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration)) => `Promise`<`void`\>
|
||||
|
||||
#### Type declaration
|
||||
|
||||
(`options`, `moduleDeclaration?`): `Promise`<`void`\>
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`LoaderOptions`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#loaderoptions)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "moduleDeclaration",
|
||||
"type": "[`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ModuleResolution
|
||||
|
||||
**ModuleResolution**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "definition",
|
||||
"type": "[`ModuleDefinition`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduledefinition)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "dependencies",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "moduleDeclaration",
|
||||
"type": "[`InternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#internalmoduledeclaration) \\| [`ExternalModuleDeclaration`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#externalmoduledeclaration)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "moduleExports",
|
||||
"type": "[`ModuleExports`](admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#moduleexports)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "resolutionPath",
|
||||
"type": "`string` \\| ``false``",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ModuleServiceInitializeCustomDataLayerOptions
|
||||
|
||||
**ModuleServiceInitializeCustomDataLayerOptions**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "repositories",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ModulesResponse
|
||||
|
||||
**ModulesResponse**: { `module`: `string` ; `resolution`: `string` \| ``false`` }[]
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PricingTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).PricingTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [AddPricesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.AddPricesDTO.mdx)
|
||||
- [AddRulesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.AddRulesDTO.mdx)
|
||||
- [CalculatedPriceSetDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx)
|
||||
- [CreateCurrencyDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)
|
||||
- [CreateMoneyAmountDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx)
|
||||
- [CreatePriceRuleDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx)
|
||||
- [CreatePriceSetDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx)
|
||||
- [CreatePriceSetMoneyAmountDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountDTO.mdx)
|
||||
- [CreatePriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountRulesDTO.mdx)
|
||||
- [CreatePriceSetRuleTypeDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreatePriceSetRuleTypeDTO.mdx)
|
||||
- [CreatePricesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreatePricesDTO.mdx)
|
||||
- [CreateRuleTypeDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CreateRuleTypeDTO.mdx)
|
||||
- [CurrencyDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.CurrencyDTO.mdx)
|
||||
- [FilterableCurrencyProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx)
|
||||
- [FilterableMoneyAmountProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx)
|
||||
- [FilterablePriceRuleProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx)
|
||||
- [FilterablePriceSetMoneyAmountProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx)
|
||||
- [FilterablePriceSetMoneyAmountRulesProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx)
|
||||
- [FilterablePriceSetProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx)
|
||||
- [FilterablePriceSetRuleTypeProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx)
|
||||
- [FilterableRuleTypeProps](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx)
|
||||
- [MoneyAmountDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)
|
||||
- [PriceRuleDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PriceRuleDTO.mdx)
|
||||
- [PriceSetDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)
|
||||
- [PriceSetMoneyAmountDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)
|
||||
- [PriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx)
|
||||
- [PriceSetRuleTypeDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PriceSetRuleTypeDTO.mdx)
|
||||
- [PricingContext](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PricingContext.mdx)
|
||||
- [PricingFilters](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.PricingFilters.mdx)
|
||||
- [RemovePriceSetRulesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.RemovePriceSetRulesDTO.mdx)
|
||||
- [RuleTypeDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.RuleTypeDTO.mdx)
|
||||
- [UpdateCurrencyDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdateCurrencyDTO.mdx)
|
||||
- [UpdateMoneyAmountDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx)
|
||||
- [UpdatePriceRuleDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx)
|
||||
- [UpdatePriceSetDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdatePriceSetDTO.mdx)
|
||||
- [UpdatePriceSetMoneyAmountDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdatePriceSetMoneyAmountDTO.mdx)
|
||||
- [UpdatePriceSetMoneyAmountRulesDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdatePriceSetMoneyAmountRulesDTO.mdx)
|
||||
- [UpdatePriceSetRuleTypeDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdatePriceSetRuleTypeDTO.mdx)
|
||||
- [UpdateRuleTypeDTO](../../PricingTypes/interfaces/admin_discounts.internal.internal-1.PricingTypes.UpdateRuleTypeDTO.mdx)
|
||||
|
||||
## References
|
||||
|
||||
### IPricingModuleService
|
||||
|
||||
Re-exports [IPricingModuleService](../../internal/interfaces/admin_discounts.internal.IPricingModuleService.mdx)
|
||||
+54
@@ -0,0 +1,54 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).ProductTypes
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [ProductStatus](../../ProductTypes/enums/admin_discounts.internal.internal-1.ProductTypes.ProductStatus.mdx)
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [CreateProductCategoryDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx)
|
||||
- [CreateProductCollectionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductCollectionDTO.mdx)
|
||||
- [CreateProductDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductDTO.mdx)
|
||||
- [CreateProductOnlyDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductOnlyDTO.mdx)
|
||||
- [CreateProductOptionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductOptionDTO.mdx)
|
||||
- [CreateProductOptionOnlyDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductOptionOnlyDTO.mdx)
|
||||
- [CreateProductTagDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductTagDTO.mdx)
|
||||
- [CreateProductTypeDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductTypeDTO.mdx)
|
||||
- [CreateProductVariantDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductVariantDTO.mdx)
|
||||
- [CreateProductVariantOnlyDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductVariantOnlyDTO.mdx)
|
||||
- [CreateProductVariantOptionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.CreateProductVariantOptionDTO.mdx)
|
||||
- [FilterableProductCategoryProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductCategoryProps.mdx)
|
||||
- [FilterableProductCollectionProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx)
|
||||
- [FilterableProductOptionProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductOptionProps.mdx)
|
||||
- [FilterableProductProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductProps.mdx)
|
||||
- [FilterableProductTagProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductTagProps.mdx)
|
||||
- [FilterableProductTypeProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductTypeProps.mdx)
|
||||
- [FilterableProductVariantProps](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx)
|
||||
- [IProductModuleService](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.IProductModuleService.mdx)
|
||||
- [ProductCategoryDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)
|
||||
- [ProductCollectionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductCollectionDTO.mdx)
|
||||
- [ProductDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductDTO.mdx)
|
||||
- [ProductImageDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductImageDTO.mdx)
|
||||
- [ProductOptionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductOptionDTO.mdx)
|
||||
- [ProductOptionValueDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)
|
||||
- [ProductTagDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductTagDTO.mdx)
|
||||
- [ProductTypeDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductTypeDTO.mdx)
|
||||
- [ProductVariantDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.ProductVariantDTO.mdx)
|
||||
- [UpdateProductCategoryDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx)
|
||||
- [UpdateProductCollectionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductCollectionDTO.mdx)
|
||||
- [UpdateProductDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductDTO.mdx)
|
||||
- [UpdateProductOptionDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductOptionDTO.mdx)
|
||||
- [UpdateProductTagDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductTagDTO.mdx)
|
||||
- [UpdateProductTypeDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductTypeDTO.mdx)
|
||||
- [UpdateProductVariantDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductVariantDTO.mdx)
|
||||
- [UpdateProductVariantOnlyDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpdateProductVariantOnlyDTO.mdx)
|
||||
- [UpsertProductTagDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpsertProductTagDTO.mdx)
|
||||
- [UpsertProductTypeDTO](../../ProductTypes/interfaces/admin_discounts.internal.internal-1.ProductTypes.UpsertProductTypeDTO.mdx)
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SalesChannelTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).SalesChannelTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [SalesChannelDTO](../../SalesChannelTypes/interfaces/admin_discounts.internal.internal-1.SalesChannelTypes.SalesChannelDTO.mdx)
|
||||
- [SalesChannelLocationDTO](../../SalesChannelTypes/interfaces/admin_discounts.internal.internal-1.SalesChannelTypes.SalesChannelLocationDTO.mdx)
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SearchTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).SearchTypes
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### IndexSettings
|
||||
|
||||
**IndexSettings**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexSettings",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Settings specific to the provider. E.g. `searchableAttributes`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "primaryKey",
|
||||
"type": "`string`",
|
||||
"description": "Primary key for the index. Used to enforce unique documents in an index. See more in Meilisearch' https://docs.meilisearch.com/learn/core_concepts/primary_key.html.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transformer",
|
||||
"type": "(`document`: `any`) => `any`",
|
||||
"description": "Document transformer. Used to transform documents before they are added to the index.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+346
@@ -0,0 +1,346 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# StockLocationTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).StockLocationTypes
|
||||
|
||||
## References
|
||||
|
||||
### IStockLocationService
|
||||
|
||||
Re-exports [IStockLocationService](../../internal/interfaces/admin_discounts.internal.IStockLocationService.mdx)
|
||||
|
||||
___
|
||||
|
||||
### StockLocationDTO
|
||||
|
||||
Re-exports [StockLocationDTO](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)
|
||||
|
||||
___
|
||||
|
||||
### StockLocationExpandedDTO
|
||||
|
||||
Re-exports [StockLocationExpandedDTO](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationexpandeddto)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### CreateStockLocationInput
|
||||
|
||||
**CreateStockLocationInput**: `Object`
|
||||
|
||||
#### Schema
|
||||
|
||||
Represents the Input to create a Stock Location
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address",
|
||||
"type": "`string` \\| [`StockLocationAddressInput`](admin_discounts.internal.internal-1.StockLocationTypes.mdx#stocklocationaddressinput)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### FilterableStockLocationProps
|
||||
|
||||
**FilterableStockLocationProps**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string` \\| `string`[] \\| [`StringComparisonOperator`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.StringComparisonOperator.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### StockLocationAddressDTO
|
||||
|
||||
**StockLocationAddressDTO**: `Object`
|
||||
|
||||
#### Schema
|
||||
|
||||
Represents a Stock Location Address
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\> \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "`string` \\| ``null``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### StockLocationAddressInput
|
||||
|
||||
**StockLocationAddressInput**: `Object`
|
||||
|
||||
#### Schema
|
||||
|
||||
Represents a Stock Location Address Input
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### UpdateStockLocationInput
|
||||
|
||||
**UpdateStockLocationInput**: `Object`
|
||||
|
||||
#### Schema
|
||||
|
||||
Represents the Input to update a Stock Location
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address",
|
||||
"type": "[`StockLocationAddressInput`](admin_discounts.internal.internal-1.StockLocationTypes.mdx#stocklocationaddressinput)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# TransactionBaseTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).TransactionBaseTypes
|
||||
|
||||
## References
|
||||
|
||||
### ITransactionBaseService
|
||||
|
||||
Re-exports [ITransactionBaseService](../../internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx)
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# WorkflowTypes
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).WorkflowTypes
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [CartWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.CartWorkflow.mdx)
|
||||
- [CommonWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.CommonWorkflow.mdx)
|
||||
- [InventoryWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.InventoryWorkflow.mdx)
|
||||
- [ProductWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.ProductWorkflow.mdx)
|
||||
Reference in New Issue
Block a user