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:
co-authored by
Oli Juhl
Shahed Nasser
parent
80fe362f33
commit
aa2bb7a31b
+211
@@ -0,0 +1,211 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# BaseRepositoryService
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).BaseRepositoryService
|
||||
|
||||
Data access layer (DAL) interface to implements for any repository service.
|
||||
This layer helps to separate the business logic (service layer) from accessing the
|
||||
ORM directly and allows to switch to another ORM without changing the business logic.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### getActiveManager
|
||||
|
||||
**getActiveManager**<`TManager`\>(): `TManager`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`TManager`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### getFreshManager
|
||||
|
||||
**getFreshManager**<`TManager`\>(): `TManager`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`TManager`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### serialize
|
||||
|
||||
**serialize**<`TOutput`\>(`data`, `options?`): `Promise`<`TOutput`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TOutput",
|
||||
"type": "`object` \\| `object`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TOutput`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### transaction
|
||||
|
||||
**transaction**<`TManager`\>(`task`, `context?`): `Promise`<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "any",
|
||||
"type": "`any`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+6
-6
@@ -169,7 +169,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
#### Overrides
|
||||
|
||||
[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[construct](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#construct)
|
||||
[WritableOptions](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx).[construct](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx#construct)
|
||||
|
||||
___
|
||||
|
||||
@@ -223,7 +223,7 @@ ___
|
||||
|
||||
#### Overrides
|
||||
|
||||
[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[destroy](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#destroy)
|
||||
[WritableOptions](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx).[destroy](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx#destroy)
|
||||
|
||||
___
|
||||
|
||||
@@ -269,7 +269,7 @@ ___
|
||||
|
||||
#### Overrides
|
||||
|
||||
[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[final](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#final)
|
||||
[WritableOptions](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx).[final](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx#final)
|
||||
|
||||
___
|
||||
|
||||
@@ -315,7 +315,7 @@ ___
|
||||
|
||||
#### Overrides
|
||||
|
||||
[ReadableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx).[read](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx#read)
|
||||
[ReadableOptions](../../internal-3/interfaces/admin_discounts.internal.internal-3.ReadableOptions.mdx).[read](../../internal-3/interfaces/admin_discounts.internal.internal-3.ReadableOptions.mdx#read)
|
||||
|
||||
___
|
||||
|
||||
@@ -377,7 +377,7 @@ ___
|
||||
|
||||
#### Overrides
|
||||
|
||||
[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[write](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#write)
|
||||
[WritableOptions](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx).[write](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx#write)
|
||||
|
||||
___
|
||||
|
||||
@@ -431,4 +431,4 @@ ___
|
||||
|
||||
#### Overrides
|
||||
|
||||
[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[writev](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#writev)
|
||||
[WritableOptions](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx).[writev](../../internal-3/interfaces/admin_discounts.internal.internal-3.WritableOptions.mdx#writev)
|
||||
|
||||
-78
@@ -1,78 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindConfig
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FindConfig
|
||||
|
||||
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
|
||||
which provides correct typing of field names in its properties.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Entity",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "order",
|
||||
"type": "`object`",
|
||||
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "relations",
|
||||
"type": "`string`[]",
|
||||
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "select",
|
||||
"type": "(`string` \\| keyof `Entity`)[]",
|
||||
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "skip",
|
||||
"type": "`number`",
|
||||
"description": "A number indicating the number of records to skip before retrieving the results.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "take",
|
||||
"type": "`number`",
|
||||
"description": "A number indicating the number of records to return in the result.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "withDeleted",
|
||||
"type": "`boolean`",
|
||||
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-34
@@ -1,34 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# IFlagRouter
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IFlagRouter
|
||||
|
||||
## Implemented by
|
||||
|
||||
- [`FlagRouter`](../classes/admin_discounts.internal.FlagRouter.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "isFeatureEnabled",
|
||||
"type": "(`key`: `string`) => `boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "listFlags",
|
||||
"type": "() => [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+48
-48
@@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
### \_\_joinerConfig
|
||||
|
||||
**__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
|
||||
**__joinerConfig**(): [`ModuleJoinerConfig`](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerconfig)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
|
||||
[`ModuleJoinerConfig`](../../internal-1/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.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/modules/admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
|
||||
"type": "[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](../../internal-1/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`](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -131,7 +131,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`CreateInventoryItemInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createinventoryiteminput)",
|
||||
"type": "[`CreateInventoryItemInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createinventoryiteminput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -225,7 +225,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`CreateInventoryItemInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createinventoryiteminput)[]",
|
||||
"type": "[`CreateInventoryItemInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createinventoryiteminput)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -233,7 +233,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -285,7 +285,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[`CreateInventoryLevelInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createinventorylevelinput)",
|
||||
"type": "[`CreateInventoryLevelInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createinventorylevelinput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -293,7 +293,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -336,7 +336,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "[`CreateInventoryLevelInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createinventorylevelinput)[]",
|
||||
"type": "[`CreateInventoryLevelInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createinventorylevelinput)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -344,7 +344,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -396,7 +396,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`CreateReservationItemInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createreservationiteminput)",
|
||||
"type": "[`CreateReservationItemInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createreservationiteminput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -404,7 +404,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -447,7 +447,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`CreateReservationItemInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createreservationiteminput)[]",
|
||||
"type": "[`CreateReservationItemInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createreservationiteminput)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -455,7 +455,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -515,7 +515,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -557,7 +557,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -607,7 +607,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -649,7 +649,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -691,7 +691,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -733,7 +733,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -767,7 +767,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[`FilterableInventoryItemProps`](../../admin_discounts/modules/admin_discounts.internal.mdx#filterableinventoryitemprops)",
|
||||
"type": "[`FilterableInventoryItemProps`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#filterableinventoryitemprops)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -775,7 +775,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -783,7 +783,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -834,7 +834,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[`FilterableInventoryLevelProps`](../../admin_discounts/modules/admin_discounts.internal.mdx#filterableinventorylevelprops)",
|
||||
"type": "[`FilterableInventoryLevelProps`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#filterableinventorylevelprops)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -842,7 +842,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -850,7 +850,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -901,7 +901,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[`FilterableReservationItemProps`](../../admin_discounts/modules/admin_discounts.internal.mdx#filterablereservationitemprops)",
|
||||
"type": "[`FilterableReservationItemProps`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#filterablereservationitemprops)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -909,7 +909,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -917,7 +917,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -976,7 +976,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1026,7 +1026,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1077,7 +1077,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1085,7 +1085,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1144,7 +1144,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1195,7 +1195,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1254,7 +1254,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1313,7 +1313,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1364,7 +1364,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`CreateInventoryItemInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createinventoryiteminput)",
|
||||
"type": "[`CreateInventoryItemInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#createinventoryiteminput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1372,7 +1372,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1431,7 +1431,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "update",
|
||||
"type": "[`UpdateInventoryLevelInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateinventorylevelinput)",
|
||||
"type": "[`UpdateInventoryLevelInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#updateinventorylevelinput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1439,7 +1439,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1482,7 +1482,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "updates",
|
||||
"type": "{ `inventory_item_id`: `string` ; `location_id`: `string` } & [`UpdateInventoryLevelInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateinventorylevelinput)[]",
|
||||
"type": "{ `inventory_item_id`: `string` ; `location_id`: `string` } & [`UpdateInventoryLevelInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#updateinventorylevelinput)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1490,7 +1490,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -1550,7 +1550,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`UpdateReservationItemInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updatereservationiteminput)",
|
||||
"type": "[`UpdateReservationItemInput`](../../internal-1/modules/admin_discounts.internal.internal-1.InventoryTypes.mdx#updatereservationiteminput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -1558,7 +1558,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+5665
File diff suppressed because it is too large
Load Diff
-386
@@ -1,386 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ISearchService
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ISearchService
|
||||
|
||||
## Implemented by
|
||||
|
||||
- [`AbstractSearchService`](../classes/admin_discounts.internal.AbstractSearchService.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### addDocuments
|
||||
|
||||
**addDocuments**(`indexName`, `documents`, `type`): `unknown`
|
||||
|
||||
Used to index documents by the search engine provider
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "documents",
|
||||
"type": "`unknown`",
|
||||
"description": "documents array to be indexed",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "`string`",
|
||||
"description": "of documents to be added (e.g: products, regions, orders, etc)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### createIndex
|
||||
|
||||
**createIndex**(`indexName`, `options`): `unknown`
|
||||
|
||||
Used to create an index
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`unknown`",
|
||||
"description": "the options",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteAllDocuments
|
||||
|
||||
**deleteAllDocuments**(`indexName`): `unknown`
|
||||
|
||||
Used to delete all documents
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteDocument
|
||||
|
||||
**deleteDocument**(`indexName`, `document_id`): `unknown`
|
||||
|
||||
Used to delete document
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "document_id",
|
||||
"type": "`string` \\| `number`",
|
||||
"description": "the id of the document",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getIndex
|
||||
|
||||
**getIndex**(`indexName`): `unknown`
|
||||
|
||||
Used to get an index
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### replaceDocuments
|
||||
|
||||
**replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
|
||||
|
||||
Used to replace documents
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "documents",
|
||||
"type": "`unknown`",
|
||||
"description": "array of document objects that will replace existing documents",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "`string`",
|
||||
"description": "type of documents to be replaced (e.g: products, regions, orders, etc)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### search
|
||||
|
||||
**search**(`indexName`, `query`, `options`): `unknown`
|
||||
|
||||
Used to search for a document in an index
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "query",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "the search query",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`unknown`",
|
||||
"description": "any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### updateSettings
|
||||
|
||||
**updateSettings**(`indexName`, `settings`): `unknown`
|
||||
|
||||
Used to update the settings of an index
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "indexName",
|
||||
"type": "`string`",
|
||||
"description": "the index name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "settings",
|
||||
"type": "`unknown`",
|
||||
"description": "settings object",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "unknown",
|
||||
"type": "`unknown`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "returns response from search engine provider",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+16
-16
@@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
### \_\_joinerConfig
|
||||
|
||||
**__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
|
||||
**__joinerConfig**(): [`ModuleJoinerConfig`](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerconfig)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig)
|
||||
[`ModuleJoinerConfig`](../../internal-1/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.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/modules/admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
|
||||
"type": "[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](../../internal-1/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`](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`CreateStockLocationInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createstocklocationinput)",
|
||||
"type": "[`CreateStockLocationInput`](../../internal-1/modules/admin_discounts.internal.internal-1.StockLocationTypes.mdx#createstocklocationinput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -48,7 +48,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -99,7 +99,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -133,7 +133,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[`FilterableStockLocationProps`](../../admin_discounts/modules/admin_discounts.internal.mdx#filterablestocklocationprops)",
|
||||
"type": "[`FilterableStockLocationProps`](../../internal-1/modules/admin_discounts.internal.internal-1.StockLocationTypes.mdx#filterablestocklocationprops)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -201,7 +201,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[`FilterableStockLocationProps`](../../admin_discounts/modules/admin_discounts.internal.mdx#filterablestocklocationprops)",
|
||||
"type": "[`FilterableStockLocationProps`](../../internal-1/modules/admin_discounts.internal.internal-1.StockLocationTypes.mdx#filterablestocklocationprops)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -209,7 +209,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -217,7 +217,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -276,7 +276,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](admin_discounts.internal.FindConfig.mdx)<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\\>",
|
||||
"type": "[`FindConfig`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.FindConfig.mdx)<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -284,7 +284,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -335,7 +335,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "input",
|
||||
"type": "[`UpdateStockLocationInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updatestocklocationinput)",
|
||||
"type": "[`UpdateStockLocationInput`](../../internal-1/modules/admin_discounts.internal.internal-1.StockLocationTypes.mdx#updatestocklocationinput)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -343,7 +343,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
|
||||
"type": "[`SharedContext`](../modules/admin_discounts.internal.internal-1.mdx#sharedcontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
-70
@@ -1,70 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# JoinerServiceConfig
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).JoinerServiceConfig
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "alias",
|
||||
"type": "[`JoinerServiceConfigAlias`](admin_discounts.internal.JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](admin_discounts.internal.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`](../../admin_discounts/modules/admin_discounts.internal.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`](../../admin_discounts/modules/admin_discounts.internal.mdx#joinerrelationship)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "serviceName",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-30
@@ -1,30 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# JoinerServiceConfigAlias
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.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": []
|
||||
}
|
||||
]} />
|
||||
-46
@@ -1,46 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# NumericalComparisonOperator
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).NumericalComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "gt",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "gte",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "lt",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "lte",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-70
@@ -1,70 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# StringComparisonOperator
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StringComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "contains",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "ends_with",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "gt",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "gte",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "lt",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "lte",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "starts_with",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
Reference in New Issue
Block a user