asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5516)

Browse Source 
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]
2023-11-02 09:16:47 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx
+71
View File
@@ -0,0 +1,71 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# Context
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).Context
The interface tag is used to ensure that the type is documented similar to interfaces.
A shared context object that is used to share resources between the application and the module.
## Type parameters
<ParameterTypes parameters={[
{
"name": "TManager",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
## Properties
<ParameterTypes parameters={[
{
"name": "enableNestedTransactions",
"type": "`boolean`",
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"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": "",
"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": "",
"children": []
},
{
"name": "transactionId",
"type": "`string`",
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"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": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.ILinkModule.mdx
+461
View File
@@ -0,0 +1,461 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ILinkModule
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).ILinkModule
## Methods
### \_\_joinerConfig
**__joinerConfig**(): [`ModuleJoinerConfig`](../modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerconfig)
#### Returns
[`ModuleJoinerConfig`](../modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerconfig)
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](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`](../modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
___
### create
**create**(`primaryKeyOrBulkData`, `foreignKeyData?`, `sharedContext?`): `Promise`<`unknown`[]\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "primaryKeyOrBulkData",
"type": "`string` \\| `string`[] \\| [`string` \\| `string`[], `string`, Record<string, unknown\\\\>?][]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "foreignKeyData",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`unknown`[]\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`[]\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown[]",
"type": "`unknown`[]",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown",
"type": "`unknown`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]
}
]} />
___
### delete
**delete**(`data`, `sharedContext?`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### dismiss
**dismiss**(`primaryKeyOrBulkData`, `foreignKeyData?`, `sharedContext?`): `Promise`<`unknown`[]\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "primaryKeyOrBulkData",
"type": "`string` \\| `string`[] \\| [`string` \\| `string`[], `string`][]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "foreignKeyData",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`unknown`[]\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`[]\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown[]",
"type": "`unknown`[]",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown",
"type": "`unknown`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]
}
]} />
___
### list
**list**(`filters?`, `config?`, `sharedContext?`): `Promise`<`unknown`[]\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "filters",
"type": "Record<`string`, `unknown`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<`unknown`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`unknown`[]\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`[]\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown[]",
"type": "`unknown`[]",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown",
"type": "`unknown`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]
}
]} />
___
### listAndCount
**listAndCount**(`filters?`, `config?`, `sharedContext?`): `Promise`<[`unknown`[], `number`]\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "filters",
"type": "Record<`string`, `unknown`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<`unknown`\\>",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<[`unknown`[], `number`]\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`unknown`[], `number`]\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown[]",
"type": "`unknown`[]",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
},
{
"name": "number",
"type": "`number`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
___
### restore
**restore**(`data`, `config?`, `sharedContext?`): `Promise`<`void` \| Record<`string`, `unknown`[]\>\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "config",
"type": "[`RestoreReturn`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.RestoreReturn.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void` \| Record<`string`, `unknown`[]\>\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| Record<`string`, `unknown`[]\\>\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "void \\| Record<string, unknown[]\\>",
"type": "`void` \\| Record<`string`, `unknown`[]\\>",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
___
### softDelete
**softDelete**(`data`, `config?`, `sharedContext?`): `Promise`<`void` \| Record<`string`, `unknown`[]\>\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "config",
"type": "[`SoftDeleteReturn`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.SoftDeleteReturn.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sharedContext",
"type": "[`Context`](admin_discounts.internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void` \| Record<`string`, `unknown`[]\>\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| Record<`string`, `unknown`[]\\>\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "void \\| Record<string, unknown[]\\>",
"type": "`void` \\| Record<`string`, `unknown`[]\\>",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.JoinerArgument.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerArgument
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).JoinerArgument
## Properties
<ParameterTypes parameters={[
{
"name": "name",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "value",
"type": "`any`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.JoinerDirective.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerDirective
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).JoinerDirective
## Properties
<ParameterTypes parameters={[
{
"name": "name",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "value",
"type": "`any`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.JoinerServiceConfig.mdx
+70
View File
@@ -0,0 +1,70 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfig
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).JoinerServiceConfig
## Properties
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[`JoinerServiceConfigAlias`](admin_discounts.internal.internal-1.JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](admin_discounts.internal.internal-1.JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "extends",
"type": "{ `relationship`: [`JoinerRelationship`](../../internal/modules/admin_discounts.internal.internal-1.mdx#joinerrelationship) ; `serviceName`: `string` }[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "fieldAlias",
"type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>",
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "primaryKeys",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "relationships",
"type": "[`JoinerRelationship`](../../internal/modules/admin_discounts.internal.internal-1.mdx#joinerrelationship)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.JoinerServiceConfigAlias.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfigAlias
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).JoinerServiceConfigAlias
## Properties
<ParameterTypes parameters={[
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.ProductCategoryTransformOptions.mdx
+22
View File
@@ -0,0 +1,22 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ProductCategoryTransformOptions
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).ProductCategoryTransformOptions
## Properties
<ParameterTypes parameters={[
{
"name": "includeDescendantsTree",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.RemoteExpandProperty.mdx
+70
View File
@@ -0,0 +1,70 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RemoteExpandProperty
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).RemoteExpandProperty
## Properties
<ParameterTypes parameters={[
{
"name": "args",
"type": "[`JoinerArgument`](admin_discounts.internal.internal-1.JoinerArgument.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "expands",
"type": "[`RemoteNestedExpands`](admin_discounts.internal.internal-1.RemoteNestedExpands.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "parent",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "parentConfig",
"type": "[`JoinerServiceConfig`](admin_discounts.internal.internal-1.JoinerServiceConfig.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "property",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "serviceConfig",
"type": "[`JoinerServiceConfig`](admin_discounts.internal.internal-1.JoinerServiceConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.RemoteJoinerQuery.mdx
+62
View File
@@ -0,0 +1,62 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RemoteJoinerQuery
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).RemoteJoinerQuery
## Properties
<ParameterTypes parameters={[
{
"name": "alias",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "args",
"type": "[`JoinerArgument`](admin_discounts.internal.internal-1.JoinerArgument.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "directives",
"type": "`object`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "expands",
"type": "{ `args?`: [`JoinerArgument`](admin_discounts.internal.internal-1.JoinerArgument.mdx)[] ; `directives?`: { `[field: string]`: [`JoinerDirective`](admin_discounts.internal.internal-1.JoinerDirective.mdx)[]; } ; `fields`: `string`[] ; `property`: `string` }[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "service",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-1/interfaces/admin_discounts.internal.internal-1.RemoteNestedExpands.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RemoteNestedExpands
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).RemoteNestedExpands
## Indexable
▪ [key: `string`]: { `args?`: [`JoinerArgument`](admin_discounts.internal.internal-1.JoinerArgument.mdx)[] ; `expands?`: [`RemoteNestedExpands`](admin_discounts.internal.internal-1.RemoteNestedExpands.mdx) ; `fields`: `string`[] }