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
+5
-5
@@ -17,7 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "eventToSubscribersMap_",
|
||||
"type": "`Map`<`string` \\| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\\>",
|
||||
"type": "`Map`<`string` \\| `symbol`, [`SubscriberDescriptor`](../../internal-1/modules/admin_discounts.internal.internal-1.EventBusTypes.mdx#subscriberdescriptor)[]\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -29,16 +29,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
### eventToSubscribersMap
|
||||
|
||||
`get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\>
|
||||
`get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../internal-1/modules/admin_discounts.internal.internal-1.EventBusTypes.mdx#subscriberdescriptor)[]\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\>
|
||||
`Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../internal-1/modules/admin_discounts.internal.internal-1.EventBusTypes.mdx#subscriberdescriptor)[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Map",
|
||||
"type": "`Map`<`string` \\| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\\>",
|
||||
"type": "`Map`<`string` \\| `symbol`, [`SubscriberDescriptor`](../../internal-1/modules/admin_discounts.internal.internal-1.EventBusTypes.mdx#subscriberdescriptor)[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -53,7 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "SubscriberDescriptor[]",
|
||||
"type": "[`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]",
|
||||
"type": "[`SubscriberDescriptor`](../../internal-1/modules/admin_discounts.internal.internal-1.EventBusTypes.mdx#subscriberdescriptor)[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
+10
-10
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Implements
|
||||
|
||||
- [`ISearchService`](../interfaces/admin_discounts.internal.ISearchService.mdx)
|
||||
- [`ISearchService`](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -73,7 +73,7 @@ Record<`string`, `unknown`\>
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[options](../interfaces/admin_discounts.internal.ISearchService.mdx#options)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[options](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#options)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -129,7 +129,7 @@ Used to index documents by the search engine provider
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[addDocuments](../interfaces/admin_discounts.internal.ISearchService.mdx#adddocuments)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[addDocuments](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#adddocuments)
|
||||
|
||||
___
|
||||
|
||||
@@ -177,7 +177,7 @@ Used to create an index
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[createIndex](../interfaces/admin_discounts.internal.ISearchService.mdx#createindex)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[createIndex](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#createindex)
|
||||
|
||||
___
|
||||
|
||||
@@ -217,7 +217,7 @@ Used to delete all documents
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[deleteAllDocuments](../interfaces/admin_discounts.internal.ISearchService.mdx#deletealldocuments)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[deleteAllDocuments](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#deletealldocuments)
|
||||
|
||||
___
|
||||
|
||||
@@ -265,7 +265,7 @@ Used to delete document
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[deleteDocument](../interfaces/admin_discounts.internal.ISearchService.mdx#deletedocument)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[deleteDocument](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#deletedocument)
|
||||
|
||||
___
|
||||
|
||||
@@ -305,7 +305,7 @@ Used to get an index
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[getIndex](../interfaces/admin_discounts.internal.ISearchService.mdx#getindex)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[getIndex](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#getindex)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +361,7 @@ Used to replace documents
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[replaceDocuments](../interfaces/admin_discounts.internal.ISearchService.mdx#replacedocuments)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[replaceDocuments](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#replacedocuments)
|
||||
|
||||
___
|
||||
|
||||
@@ -417,7 +417,7 @@ Used to search for a document in an index
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[search](../interfaces/admin_discounts.internal.ISearchService.mdx#search)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[search](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#search)
|
||||
|
||||
___
|
||||
|
||||
@@ -465,4 +465,4 @@ Used to update the settings of an index
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[updateSettings](../interfaces/admin_discounts.internal.ISearchService.mdx#updatesettings)
|
||||
[ISearchService](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx).[updateSettings](../../SearchTypes/interfaces/admin_discounts.internal.internal-1.SearchTypes.ISearchService.mdx#updatesettings)
|
||||
|
||||
+5
-5
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Implements
|
||||
|
||||
- [`IFlagRouter`](../interfaces/admin_discounts.internal.IFlagRouter.mdx)
|
||||
- [`IFlagRouter`](../../FeatureFlagTypes/interfaces/admin_discounts.internal.internal-1.FeatureFlagTypes.IFlagRouter.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -69,17 +69,17 @@ An example of a nested flag is workflows. To use it, you would do:
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[IFlagRouter](../interfaces/admin_discounts.internal.IFlagRouter.mdx).[isFeatureEnabled](../interfaces/admin_discounts.internal.IFlagRouter.mdx#isfeatureenabled)
|
||||
[IFlagRouter](../../FeatureFlagTypes/interfaces/admin_discounts.internal.internal-1.FeatureFlagTypes.IFlagRouter.mdx).[isFeatureEnabled](../../FeatureFlagTypes/interfaces/admin_discounts.internal.internal-1.FeatureFlagTypes.IFlagRouter.mdx#isfeatureenabled)
|
||||
|
||||
___
|
||||
|
||||
### listFlags
|
||||
|
||||
**listFlags**(): [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)
|
||||
**listFlags**(): [`FeatureFlagsResponse`](../../internal-1/modules/admin_discounts.internal.internal-1.FeatureFlagTypes.mdx#featureflagsresponse)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)
|
||||
[`FeatureFlagsResponse`](../../internal-1/modules/admin_discounts.internal.internal-1.FeatureFlagTypes.mdx#featureflagsresponse)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Implementation of
|
||||
|
||||
[IFlagRouter](../interfaces/admin_discounts.internal.IFlagRouter.mdx).[listFlags](../interfaces/admin_discounts.internal.IFlagRouter.mdx#listflags)
|
||||
[IFlagRouter](../../FeatureFlagTypes/interfaces/admin_discounts.internal.internal-1.FeatureFlagTypes.IFlagRouter.mdx).[listFlags](../../FeatureFlagTypes/interfaces/admin_discounts.internal.internal-1.FeatureFlagTypes.IFlagRouter.mdx#listflags)
|
||||
|
||||
___
|
||||
|
||||
|
||||
+2
-2
@@ -4009,7 +4009,7 @@ A utility method for creating Readable Streams out of iterators.
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`ReadableOptions`](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx)",
|
||||
"type": "[`ReadableOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.ReadableOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -4057,7 +4057,7 @@ A utility method for creating a `Readable` from a web `ReadableStream`.
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`ReadableOptions`](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx), ``\"signal\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>",
|
||||
"type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`ReadableOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.ReadableOptions.mdx), ``\"signal\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+1
-1
@@ -4264,7 +4264,7 @@ A utility method for creating Readable Streams out of iterators.
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`ReadableOptions`](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx)",
|
||||
"type": "[`ReadableOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.ReadableOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+22
-22
@@ -110,7 +110,7 @@ v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[addListener](admin_discounts.internal.internal-5.mdx#addlistener)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[addListener](admin_discounts.internal.internal-6.mdx#addlistener)
|
||||
|
||||
___
|
||||
|
||||
@@ -198,7 +198,7 @@ v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[emit](admin_discounts.internal.internal-5.mdx#emit)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[emit](admin_discounts.internal.internal-6.mdx#emit)
|
||||
|
||||
___
|
||||
|
||||
@@ -253,7 +253,7 @@ v6.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[eventNames](admin_discounts.internal.internal-5.mdx#eventnames)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[eventNames](admin_discounts.internal.internal-6.mdx#eventnames)
|
||||
|
||||
___
|
||||
|
||||
@@ -285,7 +285,7 @@ v1.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[getMaxListeners](admin_discounts.internal.internal-5.mdx#getmaxlisteners)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[getMaxListeners](admin_discounts.internal.internal-6.mdx#getmaxlisteners)
|
||||
|
||||
___
|
||||
|
||||
@@ -339,7 +339,7 @@ v3.2.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[listenerCount](admin_discounts.internal.internal-5.mdx#listenercount)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[listenerCount](admin_discounts.internal.internal-6.mdx#listenercount)
|
||||
|
||||
___
|
||||
|
||||
@@ -391,7 +391,7 @@ v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[listeners](admin_discounts.internal.internal-5.mdx#listeners)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[listeners](admin_discounts.internal.internal-6.mdx#listeners)
|
||||
|
||||
___
|
||||
|
||||
@@ -443,7 +443,7 @@ v10.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[off](admin_discounts.internal.internal-5.mdx#off)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[off](admin_discounts.internal.internal-6.mdx#off)
|
||||
|
||||
___
|
||||
|
||||
@@ -520,7 +520,7 @@ v0.1.101
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[on](admin_discounts.internal.internal-5.mdx#on)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[on](admin_discounts.internal.internal-6.mdx#on)
|
||||
|
||||
___
|
||||
|
||||
@@ -595,7 +595,7 @@ v0.3.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[once](admin_discounts.internal.internal-6.mdx#once)
|
||||
|
||||
___
|
||||
|
||||
@@ -651,7 +651,7 @@ ___
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[pipe](admin_discounts.internal.internal-5.mdx#pipe)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[pipe](admin_discounts.internal.internal-6.mdx#pipe)
|
||||
|
||||
___
|
||||
|
||||
@@ -714,7 +714,7 @@ v6.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[prependListener](admin_discounts.internal.internal-5.mdx#prependlistener)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[prependListener](admin_discounts.internal.internal-6.mdx#prependlistener)
|
||||
|
||||
___
|
||||
|
||||
@@ -775,7 +775,7 @@ v6.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[prependOnceListener](admin_discounts.internal.internal-5.mdx#prependoncelistener)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[prependOnceListener](admin_discounts.internal.internal-6.mdx#prependoncelistener)
|
||||
|
||||
___
|
||||
|
||||
@@ -845,7 +845,7 @@ v9.4.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[rawListeners](admin_discounts.internal.internal-5.mdx#rawlisteners)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[rawListeners](admin_discounts.internal.internal-6.mdx#rawlisteners)
|
||||
|
||||
___
|
||||
|
||||
@@ -895,7 +895,7 @@ v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[removeAllListeners](admin_discounts.internal.internal-5.mdx#removealllisteners)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[removeAllListeners](admin_discounts.internal.internal-6.mdx#removealllisteners)
|
||||
|
||||
___
|
||||
|
||||
@@ -1025,7 +1025,7 @@ v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[removeListener](admin_discounts.internal.internal-5.mdx#removelistener)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[removeListener](admin_discounts.internal.internal-6.mdx#removelistener)
|
||||
|
||||
___
|
||||
|
||||
@@ -1074,7 +1074,7 @@ v0.3.5
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[setMaxListeners](admin_discounts.internal.internal-5.mdx#setmaxlisteners)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[setMaxListeners](admin_discounts.internal.internal-6.mdx#setmaxlisteners)
|
||||
|
||||
___
|
||||
|
||||
@@ -1149,7 +1149,7 @@ v15.2.0, v14.17.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[getEventListeners](admin_discounts.internal.internal-5.mdx#geteventlisteners)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[getEventListeners](admin_discounts.internal.internal-6.mdx#geteventlisteners)
|
||||
|
||||
___
|
||||
|
||||
@@ -1215,7 +1215,7 @@ Since v3.2.0 - Use `listenerCount` instead.
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[listenerCount](admin_discounts.internal.internal-5.mdx#listenercount-1)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[listenerCount](admin_discounts.internal.internal-6.mdx#listenercount-1)
|
||||
|
||||
___
|
||||
|
||||
@@ -1337,7 +1337,7 @@ v13.6.0, v12.16.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[on](admin_discounts.internal.internal-5.mdx#on-1)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[on](admin_discounts.internal.internal-6.mdx#on-1)
|
||||
|
||||
___
|
||||
|
||||
@@ -1490,7 +1490,7 @@ v11.13.0, v10.16.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once-1)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[once](admin_discounts.internal.internal-6.mdx#once-1)
|
||||
|
||||
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||
|
||||
@@ -1558,7 +1558,7 @@ v11.13.0, v10.16.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once-1)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[once](admin_discounts.internal.internal-6.mdx#once-1)
|
||||
|
||||
___
|
||||
|
||||
@@ -1617,4 +1617,4 @@ v15.4.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[internal](admin_discounts.internal.internal-5.mdx).[setMaxListeners](admin_discounts.internal.internal-5.mdx#setmaxlisteners-1)
|
||||
[internal](admin_discounts.internal.internal-6.mdx).[setMaxListeners](admin_discounts.internal.internal-6.mdx#setmaxlisteners-1)
|
||||
|
||||
+28
-28
@@ -64,7 +64,7 @@ v0.1.26
|
||||
|
||||
### addListener
|
||||
|
||||
**addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Alias for `emitter.on(eventName, listener)`.
|
||||
|
||||
@@ -91,12 +91,12 @@ Alias for `emitter.on(eventName, listener)`.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -262,7 +262,7 @@ ___
|
||||
**getMaxListeners**(): `number`
|
||||
|
||||
Returns the current max listener value for the `EventEmitter` which is either
|
||||
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-5.mdx#defaultmaxlisteners).
|
||||
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-6.mdx#defaultmaxlisteners).
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -397,7 +397,7 @@ ___
|
||||
|
||||
### off
|
||||
|
||||
**off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Alias for `emitter.removeListener()`.
|
||||
|
||||
@@ -424,12 +424,12 @@ Alias for `emitter.removeListener()`.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -449,7 +449,7 @@ ___
|
||||
|
||||
### on
|
||||
|
||||
**on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Adds the `listener` function to the end of the listeners array for the
|
||||
event named `eventName`. No checks are made to see if the `listener` has
|
||||
@@ -501,12 +501,12 @@ myEE.emit('foo');
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -526,7 +526,7 @@ ___
|
||||
|
||||
### once
|
||||
|
||||
**once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Adds a **one-time**`listener` function for the event named `eventName`. The
|
||||
next time `eventName` is triggered, this listener is removed and then invoked.
|
||||
@@ -576,12 +576,12 @@ myEE.emit('foo');
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -653,7 +653,7 @@ ___
|
||||
|
||||
### prependListener
|
||||
|
||||
**prependListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**prependListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Adds the `listener` function to the _beginning_ of the listeners array for the
|
||||
event named `eventName`. No checks are made to see if the `listener` has
|
||||
@@ -691,12 +691,12 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -716,7 +716,7 @@ ___
|
||||
|
||||
### prependOnceListener
|
||||
|
||||
**prependOnceListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**prependOnceListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
|
||||
listener is removed, and then invoked.
|
||||
@@ -752,12 +752,12 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -847,7 +847,7 @@ ___
|
||||
|
||||
### removeAllListeners
|
||||
|
||||
**removeAllListeners**(`event?`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**removeAllListeners**(`event?`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Removes all listeners, or those of the specified `eventName`.
|
||||
|
||||
@@ -872,12 +872,12 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -897,7 +897,7 @@ ___
|
||||
|
||||
### removeListener
|
||||
|
||||
**removeListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**removeListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
Removes the specified `listener` from the listener array for the event named`eventName`.
|
||||
|
||||
@@ -1002,12 +1002,12 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -1027,7 +1027,7 @@ ___
|
||||
|
||||
### setMaxListeners
|
||||
|
||||
**setMaxListeners**(`n`): [`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
**setMaxListeners**(`n`): [`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
By default `EventEmitter`s will print a warning if more than `10` listeners are
|
||||
added for a particular event. This is a useful default that helps finding
|
||||
@@ -1051,12 +1051,12 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`internal`](admin_discounts.internal.internal-5.mdx)
|
||||
[`internal`](admin_discounts.internal.internal-6.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "internal",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-5.mdx)",
|
||||
"type": "[`internal`](admin_discounts.internal.internal-6.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminGetProductParams
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductParams
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "expand",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "fields",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-1
@@ -164,7 +164,7 @@ The title of the Product`published`.
|
||||
"name": "status",
|
||||
"type": "[`ProductStatus`](../enums/admin_collections.internal.ProductStatus.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
|
||||
+74
@@ -345,6 +345,80 @@ Calculate and return the gift cards totals based on their transactions
|
||||
|
||||
___
|
||||
|
||||
### getGiftCardableAmount
|
||||
|
||||
**getGiftCardableAmount**(`«destructured»`): `number`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "__namedParameters",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "__namedParameters.discount_total",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "__namedParameters.gift_cards_taxable",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "__namedParameters.shipping_total",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "__namedParameters.subtotal",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "__namedParameters.tax_total",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemRefund
|
||||
|
||||
**getLineItemRefund**(`lineItem`, `«destructured»`): `number`
|
||||
|
||||
+144
@@ -45,6 +45,14 @@ Allows retrieval of prices.
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "getPricingModuleVariantMoneyAmounts",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "getProductPricing_",
|
||||
"type": "`any`",
|
||||
@@ -53,6 +61,14 @@ Allows retrieval of prices.
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "getProductVariantPricingModulePricing_",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "getProductVariantPricing_",
|
||||
"type": "`any`",
|
||||
@@ -77,6 +93,14 @@ Allows retrieval of prices.
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "pricingModuleService",
|
||||
"type": "[`IPricingModuleService`](../interfaces/admin_discounts.internal.IPricingModuleService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "productVariantService",
|
||||
"type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)",
|
||||
@@ -93,6 +117,14 @@ Allows retrieval of prices.
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "remoteQuery",
|
||||
"type": "[`RemoteQueryFunction`](../../admin_discounts/modules/admin_discounts.internal.mdx#remotequeryfunction)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "taxProviderService",
|
||||
"type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)",
|
||||
@@ -662,6 +694,118 @@ Gets the prices for a shipping option.
|
||||
|
||||
___
|
||||
|
||||
### setAdminProductPricing
|
||||
|
||||
**setAdminProductPricing**(`products`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "products",
|
||||
"type": "[`Product`](admin_collections.internal.Product.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<([`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "(Product \\| PricedProduct)[]",
|
||||
"type": "([`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "Product \\| PricedProduct",
|
||||
"type": "[`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### setAdminVariantPricing
|
||||
|
||||
**setAdminVariantPricing**(`variants`, `context?`): `Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "variants",
|
||||
"type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "PricedVariant[]",
|
||||
"type": "[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "PricedVariant",
|
||||
"type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\\> & [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)",
|
||||
"description": "#### Schema PricedVariant title: \"Priced Product Variant\" type: object allOf: - $ref: \"#/components/schemas/ProductVariant\" - type: object properties: original_price: type: number description: The original price of the variant without any discounted prices applied. calculated_price: type: number description: The calculated price of the variant. Can be a discounted price. original_price_incl_tax: type: number description: The original price of the variant including taxes. calculated_price_incl_tax: type: number description: The calculated price of the variant including taxes. original_tax: type: number description: The taxes applied on the original price. calculated_tax: type: number description: The taxes applied on the calculated price. tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### setProductPrices
|
||||
|
||||
**setProductPrices**(`products`, `context?`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\>
|
||||
|
||||
Reference in New Issue
Block a user