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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/interfaces/AddPricesDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ The prices to add to a price set.
},
{
"name": "prices",
"type": "[`CreatePricesDTO`](CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](CreatePricesDTO.mdx)[]",
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/AddRulesDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ The rules to add to a price set.
},
{
"name": "rules",
"type": "{ `attribute`: `string` }[]",
"type": "`{ attribute: string }`[]",
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/BaseFilterable.mdx
+2 -2
View File
@@ -27,7 +27,7 @@ An object used to allow specifying flexible queries with and/or conditions.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`BaseFilterable`](BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
"type": "([BaseFilterable](BaseFilterable.mdx)&#60;T&#62; \\| `T`)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -36,7 +36,7 @@ An object used to allow specifying flexible queries with and/or conditions.
},
{
"name": "$or",
"type": "([`BaseFilterable`](BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
"type": "([BaseFilterable](BaseFilterable.mdx)&#60;T&#62; \\| `T`)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/Boolean.mdx
+1 -1
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### valueOf
**valueOf**(): `boolean`
`**valueOf**(): boolean`
Returns the primitive value of the specified object.
www/apps/docs/content/references/services/interfaces/Buffer.mdx
+197 -197
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/services/interfaces/BufferConstructor.mdx
+80 -80
View File
@@ -8,15 +8,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Raw data is stored in instances of the Buffer class.
A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized.
Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
Valid string encodings: 'ascii'\|'utf8'\|'utf16le'\|'ucs2'(alias of 'utf16le')\|'base64'\|'base64url'\|'binary'(deprecated)\|'hex'
## Constructors
### constructor
**new BufferConstructor**(`str`, `encoding?`)
`**new BufferConstructor**(str, encoding?)`
Allocates a new buffer containing the given {str}.
Allocates a new buffer containing the given &#123;str&#125;.
#### Parameters
@@ -32,7 +32,7 @@ Allocates a new buffer containing the given {str}.
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/BufferEncoding.mdx)",
"description": "encoding to use, optional. Default is 'utf8'",
"optional": true,
"defaultValue": "",
@@ -45,9 +45,9 @@ Allocates a new buffer containing the given {str}.
since v10.0.0 - Use `Buffer.from(string[, encoding])` instead.
**new BufferConstructor**(`size`)
`**new BufferConstructor**(size)`
Allocates a new buffer of {size} octets.
Allocates a new buffer of &#123;size&#125; octets.
#### Parameters
@@ -67,16 +67,16 @@ Allocates a new buffer of {size} octets.
since v10.0.0 - Use `Buffer.alloc()` instead (also see `Buffer.allocUnsafe()`).
**new BufferConstructor**(`array`)
`**new BufferConstructor**(array)`
Allocates a new buffer containing the given {array} of octets.
Allocates a new buffer containing the given &#123;array&#125; of octets.
#### Parameters
<ParameterTypes parameters={[
{
"name": "array",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "The octets to store.",
"optional": false,
"defaultValue": "",
@@ -89,17 +89,17 @@ Allocates a new buffer containing the given {array} of octets.
since v10.0.0 - Use `Buffer.from(array)` instead.
**new BufferConstructor**(`arrayBuffer`)
`**new BufferConstructor**(arrayBuffer)`
Produces a Buffer backed by the same allocated memory as
the given {ArrayBuffer}/{SharedArrayBuffer}.
the given &#123;ArrayBuffer&#125;/&#123;SharedArrayBuffer&#125;.
#### Parameters
<ParameterTypes parameters={[
{
"name": "arrayBuffer",
"type": "`ArrayBuffer` \\| [`SharedArrayBuffer`](../index.md#sharedarraybuffer)",
"type": "`ArrayBuffer` \\| [SharedArrayBuffer](../index.md#sharedarraybuffer)",
"description": "The ArrayBuffer with which to share memory.",
"optional": false,
"defaultValue": "",
@@ -112,9 +112,9 @@ the given {ArrayBuffer}/{SharedArrayBuffer}.
since v10.0.0 - Use `Buffer.from(arrayBuffer[, byteOffset[, length]])` instead.
**new BufferConstructor**(`array`)
`**new BufferConstructor**(array)`
Allocates a new buffer containing the given {array} of octets.
Allocates a new buffer containing the given &#123;array&#125; of octets.
#### Parameters
@@ -134,16 +134,16 @@ Allocates a new buffer containing the given {array} of octets.
since v10.0.0 - Use `Buffer.from(array)` instead.
**new BufferConstructor**(`buffer`)
`**new BufferConstructor**(buffer)`
Copies the passed {buffer} data onto a new {Buffer} instance.
Copies the passed &#123;buffer&#125; data onto a new &#123;Buffer&#125; instance.
#### Parameters
<ParameterTypes parameters={[
{
"name": "buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"description": "The buffer to copy.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ since v10.0.0 - Use `Buffer.from(buffer)` instead.
### alloc
**alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../index.md#buffer)
`**alloc**(size, fill?, encoding?): [Buffer](../index.md#buffer)`
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled.
@@ -232,7 +232,7 @@ A `TypeError` will be thrown if `size` is not a number.
},
{
"name": "fill",
"type": "`string` \\| `number` \\| `Uint8Array`",
"type": "`string` \\| `number` \\| Uint8Array",
"description": "A value to pre-fill the new `Buffer` with.",
"optional": true,
"defaultValue": "",
@@ -241,7 +241,7 @@ A `TypeError` will be thrown if `size` is not a number.
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/BufferEncoding.mdx)",
"description": "If `fill` is a string, this is its encoding.",
"optional": true,
"defaultValue": "",
@@ -252,12 +252,12 @@ A `TypeError` will be thrown if `size` is not a number.
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -274,12 +274,12 @@ ___
### allocUnsafe
**allocUnsafe**(`size`): [`Buffer`](../index.md#buffer)
`**allocUnsafe**(size): [Buffer](../index.md#buffer)`
Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown.
The underlying memory for `Buffer` instances created in this way is _not_
_initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes.
The underlying memory for `Buffer` instances created in this way is \_not\_
\_initialized\_. The contents of the newly created `Buffer` are unknown and \_may contain sensitive data\_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes.
```js
import { Buffer } from 'node:buffer';
@@ -303,7 +303,7 @@ and `Buffer.concat()` only when `size` is less than or equal to`Buffer.poolSize
Use of this pre-allocated internal memory pool is a key difference between
calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
Specifically, `Buffer.alloc(size, fill)` will _never_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`_will_ use the internal`Buffer` pool if `size` is less
Specifically, `Buffer.alloc(size, fill)` will \_never\_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`\_will\_ use the internal`Buffer` pool if `size` is less
than or equal to half `Buffer.poolSize`. The
difference is subtle but can be important when an application requires the
additional performance that `Buffer.allocUnsafe()` provides.
@@ -324,12 +324,12 @@ additional performance that `Buffer.allocUnsafe()` provides.
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -346,13 +346,13 @@ ___
### allocUnsafeSlow
**allocUnsafeSlow**(`size`): [`Buffer`](../index.md#buffer)
`**allocUnsafeSlow**(size): [Buffer](../index.md#buffer)`
Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. A zero-length `Buffer` is created if
`size` is 0.
The underlying memory for `Buffer` instances created in this way is _not_
_initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `buf.fill(0)` to initialize
The underlying memory for `Buffer` instances created in this way is \_not\_
\_initialized\_. The contents of the newly created `Buffer` are unknown and \_may contain sensitive data\_. Use `buf.fill(0)` to initialize
such `Buffer` instances with zeroes.
When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,
@@ -405,12 +405,12 @@ A `TypeError` will be thrown if `size` is not a number.
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -427,10 +427,10 @@ ___
### byteLength
**byteLength**(`string`, `encoding?`): `number`
`**byteLength**(string, encoding?): number`
Returns the byte length of a string when encoded using `encoding`.
This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account
This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/String/length), which does not account
for the encoding that is used to convert the string into bytes.
For `'base64'`, `'base64url'`, and `'hex'`, this function assumes valid input.
@@ -449,16 +449,16 @@ console.log(`${str}: ${str.length} characters, ` +
```
When `string` is a
`Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/-
Reference/Global_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop-
er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned.
`Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/-
Reference/Global\_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop-
er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned.
#### Parameters
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string` \\| `ArrayBuffer` \\| [`SharedArrayBuffer`](../index.md#sharedarraybuffer) \\| [`ArrayBufferView`](../types/ArrayBufferView.mdx)",
"type": "`string` \\| `ArrayBuffer` \\| [SharedArrayBuffer](../index.md#sharedarraybuffer) \\| [ArrayBufferView](../types/ArrayBufferView.mdx)",
"description": "A value to calculate the length of.",
"optional": false,
"defaultValue": "",
@@ -467,7 +467,7 @@ er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuf
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/BufferEncoding.mdx)",
"description": "If `string` is a string, this is its encoding.",
"optional": true,
"defaultValue": "",
@@ -500,7 +500,7 @@ ___
### compare
**compare**(`buf1`, `buf2`): ``0`` \| ``1`` \| ``-1``
`**compare**(buf1, buf2): `0` \| `1` \| `-1``
Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`.
@@ -521,7 +521,7 @@ console.log(arr.sort(Buffer.compare));
<ParameterTypes parameters={[
{
"name": "buf1",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -530,7 +530,7 @@ console.log(arr.sort(Buffer.compare));
},
{
"name": "buf2",
"type": "`Uint8Array`",
"type": "Uint8Array",
"description": "",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ console.log(arr.sort(Buffer.compare));
<ParameterTypes parameters={[
{
"name": "``0`` \\| ``1`` \\| ``-1``",
"name": "`0` \\| `1` \\| `-1`",
"type": "``0`` \\| ``1`` \\| ``-1``",
"optional": true,
"defaultValue": "",
@@ -563,7 +563,7 @@ ___
### concat
**concat**(`list`, `totalLength?`): [`Buffer`](../index.md#buffer)
`**concat**(list, totalLength?): [Buffer](../index.md#buffer)`
Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
@@ -604,7 +604,7 @@ console.log(bufA.length);
<ParameterTypes parameters={[
{
"name": "list",
"type": "readonly `Uint8Array`[]",
"type": "readonly Uint8Array[]",
"description": "List of `Buffer` or Uint8Array instances to concatenate.",
"optional": false,
"defaultValue": "",
@@ -624,12 +624,12 @@ console.log(bufA.length);
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -646,7 +646,7 @@ ___
### copyBytesFrom
**copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../index.md#buffer)
`**copyBytesFrom**(view, offset?, length?): [Buffer](../index.md#buffer)`
Copies the underlying memory of `view` into a new `Buffer`.
@@ -664,8 +664,8 @@ console.log(buf[1]); // 255
<ParameterTypes parameters={[
{
"name": "view",
"type": "[`TypedArray`](../types/TypedArray.mdx)",
"description": "The {TypedArray} to copy.",
"type": "[TypedArray](../types/TypedArray.mdx)",
"description": "The &#123;TypedArray&#125; to copy.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -693,12 +693,12 @@ console.log(buf[1]); // 255
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -715,7 +715,7 @@ ___
### from
**from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../index.md#buffer)
`**from**(arrayBuffer, byteOffset?, length?): [Buffer](../index.md#buffer)`
Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`.
Array entries outside that range will be truncated to fit into it.
@@ -741,7 +741,7 @@ appropriate for `Buffer.from()` variants.
<ParameterTypes parameters={[
{
"name": "arrayBuffer",
"type": "[`WithImplicitCoercion`](../types/WithImplicitCoercion.mdx)<`ArrayBuffer` \\| [`SharedArrayBuffer`](../index.md#sharedarraybuffer)\\>",
"type": "[WithImplicitCoercion](../types/WithImplicitCoercion.mdx)&#60;ArrayBuffer \\| [SharedArrayBuffer](../index.md#sharedarraybuffer)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -770,12 +770,12 @@ appropriate for `Buffer.from()` variants.
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -788,16 +788,16 @@ appropriate for `Buffer.from()` variants.
v5.10.0
**from**(`data`): [`Buffer`](../index.md#buffer)
`**from**(data): [Buffer](../index.md#buffer)`
Creates a new Buffer using the passed {data}
Creates a new Buffer using the passed &#123;data&#125;
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`Uint8Array` \\| readonly `number`[]",
"type": "Uint8Array \\| readonly `number`[]",
"description": "data to create a new Buffer",
"optional": false,
"defaultValue": "",
@@ -808,12 +808,12 @@ Creates a new Buffer using the passed {data}
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -822,14 +822,14 @@ Creates a new Buffer using the passed {data}
}
]} />
**from**(`data`): [`Buffer`](../index.md#buffer)
`**from**(data): [Buffer](../index.md#buffer)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`WithImplicitCoercion`](../types/WithImplicitCoercion.mdx)<`string` \\| `Uint8Array` \\| readonly `number`[]\\>",
"type": "[WithImplicitCoercion](../types/WithImplicitCoercion.mdx)&#60;string \\| Uint8Array \\| readonly number[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -840,12 +840,12 @@ Creates a new Buffer using the passed {data}
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -854,18 +854,18 @@ Creates a new Buffer using the passed {data}
}
]} />
**from**(`str`, `encoding?`): [`Buffer`](../index.md#buffer)
`**from**(str, encoding?): [Buffer](../index.md#buffer)`
Creates a new Buffer containing the given JavaScript string {str}.
If provided, the {encoding} parameter identifies the character encoding.
If not provided, {encoding} defaults to 'utf8'.
Creates a new Buffer containing the given JavaScript string &#123;str&#125;.
If provided, the &#123;encoding&#125; parameter identifies the character encoding.
If not provided, &#123;encoding&#125; defaults to 'utf8'.
#### Parameters
<ParameterTypes parameters={[
{
"name": "str",
"type": "[`WithImplicitCoercion`](../types/WithImplicitCoercion.mdx)<`string`\\> \\| { `[toPrimitive]`: Method [toPrimitive] }",
"type": "[WithImplicitCoercion](../types/WithImplicitCoercion.mdx)&#60;string&#62; \\| `&#123; [toPrimitive]: Method [toPrimitive] &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -874,7 +874,7 @@ If not provided, {encoding} defaults to 'utf8'.
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../types/BufferEncoding.mdx)",
"type": "[BufferEncoding](../types/BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -885,12 +885,12 @@ If not provided, {encoding} defaults to 'utf8'.
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -903,7 +903,7 @@ ___
### isBuffer
**isBuffer**(`obj`): obj is Buffer
`**isBuffer**(obj): obj is Buffer`
Returns `true` if `obj` is a `Buffer`, `false` otherwise.
@@ -955,7 +955,7 @@ ___
### isEncoding
**isEncoding**(`encoding`): encoding is BufferEncoding
`**isEncoding**(encoding): encoding is BufferEncoding`
Returns `true` if `encoding` is the name of a supported character encoding,
or `false` otherwise.
@@ -1014,9 +1014,9 @@ ___
### of
**of**(`...items`): [`Buffer`](../index.md#buffer)
`**of**(...items): [Buffer](../index.md#buffer)`
Creates a new Buffer using the passed {data}
Creates a new Buffer using the passed &#123;data&#125;
#### Parameters
@@ -1034,12 +1034,12 @@ Creates a new Buffer using the passed {data}
#### Returns
[`Buffer`](../index.md#buffer)
[Buffer](../index.md#buffer)
<ParameterTypes parameters={[
{
"name": "Buffer",
"type": "[`Buffer`](../index.md#buffer)",
"type": "[Buffer](../index.md#buffer)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/CreateMoneyAmountDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ The money amount to create.
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/CreateNoteInput.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "author",
"type": "[`User`](../classes/User.mdx)",
"type": "[User](../classes/User.mdx)",
"description": "A User is an administrator who can manage store settings and data.",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/CreatePriceSetDTO.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ A price set to create.
<ParameterTypes parameters={[
{
"name": "prices",
"type": "[`CreatePricesDTO`](CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](CreatePricesDTO.mdx)[]",
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ A price set to create.
},
{
"name": "rules",
"type": "{ `rule_attribute`: `string` }[]",
"type": "`&#123; rule_attribute: string &#125;`[]",
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/CreatePricesDTO.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ The prices to create part of a price set.
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ The prices to create part of a price set.
},
{
"name": "rules",
"type": "Record<`string`, `string`\\>",
"type": "`Record<string, string>`",
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/CreateRuleTypeDTO.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ The rule type to create.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/CreateUserInput.mdx
+2 -2
View File
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "role",
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterableCurrencyProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on a currency.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterableCurrencyProps`](FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableCurrencyProps`](FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](FilterableCurrencyProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableCurrencyProps](FilterableCurrencyProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on a currency.
},
{
"name": "$or",
"type": "([`FilterableCurrencyProps`](FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableCurrencyProps`](FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](FilterableCurrencyProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableCurrencyProps](FilterableCurrencyProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterableMoneyAmountProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on a money amount.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on a money amount.
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterablePriceRuleProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply to price rules.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](FilterablePriceRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](FilterablePriceRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply to price rules.
},
{
"name": "$or",
"type": "([`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](FilterablePriceRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](FilterablePriceRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on price set money amounts.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on price set money amounts.
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on price set money amount rules.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on price set money amount rules.
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterablePriceSetProps.mdx
+3 -3
View File
@@ -13,7 +13,7 @@ Filters to apply on price sets.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetProps`](FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetProps`](FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](FilterablePriceSetProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetProps](FilterablePriceSetProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on price sets.
},
{
"name": "$or",
"type": "([`FilterablePriceSetProps`](FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetProps`](FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](FilterablePriceSetProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetProps](FilterablePriceSetProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ Filters to apply on price sets.
},
{
"name": "money_amounts",
"type": "[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)",
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/FilterableRuleTypeProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on rule types.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](FilterableRuleTypeProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](FilterableRuleTypeProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on rule types.
},
{
"name": "$or",
"type": "([`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](FilterableRuleTypeProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](FilterableRuleTypeProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/IBatchJobStrategy.mdx
+32 -32
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -60,16 +60,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -82,7 +82,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -114,7 +114,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -132,7 +132,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -143,12 +143,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -161,18 +161,18 @@ ___
### buildTemplate
**buildTemplate**(): `Promise`<`string`\>
`**buildTemplate**(): Promise&#60;string&#62;`
Builds and returns a template file that can be downloaded and filled in
#### Returns
`Promise`<`string`\>
Promise&#60;string&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -185,7 +185,7 @@ ___
### preProcessBatchJob
**preProcessBatchJob**(`batchJobId`): `Promise`<`void`\>
`**preProcessBatchJob**(batchJobId): Promise&#60;void&#62;`
Method for pre-processing a batch job
@@ -205,12 +205,12 @@ Method for pre-processing a batch job
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -223,7 +223,7 @@ ___
### prepareBatchJobForProcessing
**prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\>
`**prepareBatchJobForProcessing**(batchJobEntity, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
Method for preparing a batch job for processing
@@ -232,7 +232,7 @@ Method for preparing a batch job for processing
<ParameterTypes parameters={[
{
"name": "batchJobEntity",
"type": "[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)",
"type": "[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -252,12 +252,12 @@ Method for preparing a batch job for processing
#### Returns
`Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\>
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CreateBatchJobInput`](../types/CreateBatchJobInput.mdx)\\>",
"type": "Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -270,7 +270,7 @@ ___
### processJob
**processJob**(`batchJobId`): `Promise`<`void`\>
`**processJob**(batchJobId): Promise&#60;void&#62;`
Method does the actual processing of the job. Should report back on the progress of the operation.
@@ -290,12 +290,12 @@ Method does the actual processing of the job. Should report back on the progress
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -308,14 +308,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -344,14 +344,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](IBatchJobStrategy.mdx)
`**withTransaction**(transactionManager?): [IBatchJobStrategy](IBatchJobStrategy.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -362,12 +362,12 @@ ___
#### Returns
[`IBatchJobStrategy`](IBatchJobStrategy.mdx)
[IBatchJobStrategy](IBatchJobStrategy.mdx)
<ParameterTypes parameters={[
{
"name": "IBatchJobStrategy",
"type": "[`IBatchJobStrategy`](IBatchJobStrategy.mdx)",
"type": "[IBatchJobStrategy](IBatchJobStrategy.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/ICacheService.mdx
+9 -9
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### get
**get**<`T`\>(`key`): `Promise`<``null`` \| `T`\>
`**get**<TypeParameter T>(key): Promise&#60;`null` \| T&#62;`
<ParameterTypes parameters={[
{
@@ -40,12 +40,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
`Promise`<``null`` \| `T`\>
Promise&#60;`null` \| T&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<``null`` \\| `T`\\>",
"type": "Promise&#60;`null` \\| T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -58,7 +58,7 @@ ___
### invalidate
**invalidate**(`key`): `Promise`<`void`\>
`**invalidate**(key): Promise&#60;void&#62;`
#### Parameters
@@ -76,12 +76,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -94,7 +94,7 @@ ___
### set
**set**(`key`, `data`, `ttl?`): `Promise`<`void`\>
`**set**(key, data, ttl?): Promise&#60;void&#62;`
#### Parameters
@@ -130,12 +130,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IEventBusModuleService.mdx
+18 -18
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### emit
**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\>
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void&#62;`
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -58,12 +58,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -72,7 +72,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**emit**<`T`\>(`data`): `Promise`<`void`\>
`**emit**<TypeParameter T>(data): Promise&#60;void&#62;`
<ParameterTypes parameters={[
{
@@ -91,7 +91,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`EmitData`](../types/EmitData.mdx)<`T`\\>[]",
"type": "[EmitData](../types/EmitData.mdx)&#60;T&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -102,12 +102,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -120,7 +120,7 @@ ___
### subscribe
**subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](IEventBusModuleService.mdx)
`**subscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)`
#### Parameters
@@ -136,7 +136,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)",
"type": "[Subscriber](../types/Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -145,7 +145,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -156,12 +156,12 @@ ___
#### Returns
[`IEventBusModuleService`](IEventBusModuleService.mdx)
[IEventBusModuleService](IEventBusModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[`IEventBusModuleService`](IEventBusModuleService.mdx)",
"type": "[IEventBusModuleService](IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -174,7 +174,7 @@ ___
### unsubscribe
**unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](IEventBusModuleService.mdx)
`**unsubscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)`
#### Parameters
@@ -190,7 +190,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)",
"type": "[Subscriber](../types/Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -199,7 +199,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -210,12 +210,12 @@ ___
#### Returns
[`IEventBusModuleService`](IEventBusModuleService.mdx)
[IEventBusModuleService](IEventBusModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "[`IEventBusModuleService`](IEventBusModuleService.mdx)",
"type": "[IEventBusModuleService](IEventBusModuleService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IEventBusService.mdx
+17 -17
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### emit
**emit**<`T`\>(`event`, `data`, `options?`): `Promise`<`unknown`\>
`**emit**<TypeParameter T>(event, data, options?): Promise&#60;unknown&#62;`
<ParameterTypes parameters={[
{
@@ -58,12 +58,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
`Promise`<`unknown`\>
Promise&#60;unknown&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`\\>",
"type": "Promise&#60;unknown&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -76,7 +76,7 @@ ___
### subscribe
**subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](IEventBusService.mdx)
`**subscribe**(eventName, subscriber, context?): [IEventBusService](IEventBusService.mdx)`
#### Parameters
@@ -92,7 +92,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)",
"type": "[Subscriber](../types/Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -101,7 +101,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -112,12 +112,12 @@ ___
#### Returns
[`IEventBusService`](IEventBusService.mdx)
[IEventBusService](IEventBusService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusService",
"type": "[`IEventBusService`](IEventBusService.mdx)",
"type": "[IEventBusService](IEventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -130,7 +130,7 @@ ___
### unsubscribe
**unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](IEventBusService.mdx)
`**unsubscribe**(eventName, subscriber, context?): [IEventBusService](IEventBusService.mdx)`
#### Parameters
@@ -146,7 +146,7 @@ ___
},
{
"name": "subscriber",
"type": "[`Subscriber`](../types/Subscriber.mdx)",
"type": "[Subscriber](../types/Subscriber.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -155,7 +155,7 @@ ___
},
{
"name": "context",
"type": "[`SubscriberContext`](../types/SubscriberContext.mdx)",
"type": "[SubscriberContext](../types/SubscriberContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -166,12 +166,12 @@ ___
#### Returns
[`IEventBusService`](IEventBusService.mdx)
[IEventBusService](IEventBusService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusService",
"type": "[`IEventBusService`](IEventBusService.mdx)",
"type": "[IEventBusService](IEventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -184,14 +184,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`IEventBusService`](IEventBusService.mdx)
`**withTransaction**(transactionManager?): [IEventBusService](IEventBusService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -202,12 +202,12 @@ ___
#### Returns
[`IEventBusService`](IEventBusService.mdx)
[IEventBusService](IEventBusService.mdx)
<ParameterTypes parameters={[
{
"name": "IEventBusService",
"type": "[`IEventBusService`](IEventBusService.mdx)",
"type": "[IEventBusService](IEventBusService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IFlagRouter.mdx
+1 -1
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "listFlags",
"type": "() => [`FeatureFlagsResponse`](../types/FeatureFlagsResponse.mdx)",
"type": "() => [FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/IInventoryService.mdx
+132 -132
View File
@@ -10,16 +10,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_joinerConfig
**__joinerConfig**(): [`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)
`**__joinerConfig**(): [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)`
#### Returns
[`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)
[ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../types/Omit.mdx)<[`JoinerServiceConfig`](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`](../types/ModuleJoinerRelationship.mdx) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../types/ModuleJoinerRelationship.mdx)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"type": "[Omit](../types/Omit.mdx)&#60;[JoinerServiceConfig](JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -32,7 +32,7 @@ ___
### adjustInventory
**adjustInventory**(`inventoryItemId`, `locationId`, `adjustment`, `context?`): `Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
`**adjustInventory**(inventoryItemId, locationId, adjustment, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
#### Parameters
@@ -66,7 +66,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -77,12 +77,12 @@ ___
#### Returns
`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -95,7 +95,7 @@ ___
### confirmInventory
**confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\>
`**confirmInventory**(inventoryItemId, locationIds, quantity, context?): Promise&#60;boolean&#62;`
#### Parameters
@@ -129,7 +129,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -140,12 +140,12 @@ ___
#### Returns
`Promise`<`boolean`\>
Promise&#60;boolean&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`boolean`\\>",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -158,14 +158,14 @@ ___
### createInventoryItem
**createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\>
`**createInventoryItem**(input, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateInventoryItemInput`](../types/CreateInventoryItemInput.mdx)",
"type": "[CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -185,12 +185,12 @@ ___
#### Returns
`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\>
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -203,14 +203,14 @@ ___
### createInventoryItems
**createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)[]\>
`**createInventoryItems**(input, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateInventoryItemInput`](../types/CreateInventoryItemInput.mdx)[]",
"type": "[CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -219,7 +219,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -230,12 +230,12 @@ ___
#### Returns
`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)[]\>
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)[]\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -248,14 +248,14 @@ ___
### createInventoryLevel
**createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
`**createInventoryLevel**(data, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateInventoryLevelInput`](../types/CreateInventoryLevelInput.mdx)",
"type": "[CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -275,12 +275,12 @@ ___
#### Returns
`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -293,14 +293,14 @@ ___
### createInventoryLevels
**createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[]\>
`**createInventoryLevels**(data, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateInventoryLevelInput`](../types/CreateInventoryLevelInput.mdx)[]",
"type": "[CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -320,12 +320,12 @@ ___
#### Returns
`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[]\>
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[]\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -338,14 +338,14 @@ ___
### createReservationItem
**createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\>
`**createReservationItem**(input, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateReservationItemInput`](../types/CreateReservationItemInput.mdx)",
"type": "[CreateReservationItemInput](../types/CreateReservationItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -354,7 +354,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -365,12 +365,12 @@ ___
#### Returns
`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\>
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -383,14 +383,14 @@ ___
### createReservationItems
**createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)[]\>
`**createReservationItems**(input, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateReservationItemInput`](../types/CreateReservationItemInput.mdx)[]",
"type": "[CreateReservationItemInput](../types/CreateReservationItemInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -399,7 +399,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -410,12 +410,12 @@ ___
#### Returns
`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)[]\>
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)[]\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -428,7 +428,7 @@ ___
### deleteInventoryItem
**deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
`**deleteInventoryItem**(inventoryItemId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -444,7 +444,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -455,12 +455,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -473,7 +473,7 @@ ___
### deleteInventoryItemLevelByLocationId
**deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\>
`**deleteInventoryItemLevelByLocationId**(locationId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -489,7 +489,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -500,12 +500,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -518,7 +518,7 @@ ___
### deleteInventoryLevel
**deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\>
`**deleteInventoryLevel**(inventoryLevelId, locationId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -543,7 +543,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -554,12 +554,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -572,7 +572,7 @@ ___
### deleteReservationItem
**deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\>
`**deleteReservationItem**(reservationItemId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -588,7 +588,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -599,12 +599,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -617,7 +617,7 @@ ___
### deleteReservationItemByLocationId
**deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\>
`**deleteReservationItemByLocationId**(locationId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -633,7 +633,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -644,12 +644,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -662,7 +662,7 @@ ___
### deleteReservationItemsByLineItem
**deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\>
`**deleteReservationItemsByLineItem**(lineItemId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -678,7 +678,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -689,12 +689,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -707,14 +707,14 @@ ___
### listInventoryItems
**listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)[], `number`]\>
`**listInventoryItems**(selector, config?, context?): Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableInventoryItemProps`](../types/FilterableInventoryItemProps.mdx)",
"type": "[FilterableInventoryItemProps](../types/FilterableInventoryItemProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -723,7 +723,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -732,7 +732,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -743,12 +743,12 @@ ___
#### Returns
`Promise`<[[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)[], `number`]\>
Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -761,14 +761,14 @@ ___
### listInventoryLevels
**listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[], `number`]\>
`**listInventoryLevels**(selector, config?, context?): Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableInventoryLevelProps`](../types/FilterableInventoryLevelProps.mdx)",
"type": "[FilterableInventoryLevelProps](../types/FilterableInventoryLevelProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -777,7 +777,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -786,7 +786,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -797,12 +797,12 @@ ___
#### Returns
`Promise`<[[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[], `number`]\>
Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -815,14 +815,14 @@ ___
### listReservationItems
**listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)[], `number`]\>
`**listReservationItems**(selector, config?, context?): Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableReservationItemProps`](../types/FilterableReservationItemProps.mdx)",
"type": "[FilterableReservationItemProps](../types/FilterableReservationItemProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -831,7 +831,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -840,7 +840,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -851,12 +851,12 @@ ___
#### Returns
`Promise`<[[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)[], `number`]\>
Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -869,7 +869,7 @@ ___
### restoreInventoryItem
**restoreInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
`**restoreInventoryItem**(inventoryItemId, context?): Promise&#60;void&#62;`
#### Parameters
@@ -885,7 +885,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -896,12 +896,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -914,7 +914,7 @@ ___
### retrieveAvailableQuantity
**retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
`**retrieveAvailableQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;`
#### Parameters
@@ -939,7 +939,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -950,12 +950,12 @@ ___
#### Returns
`Promise`<`number`\>
Promise&#60;number&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -968,7 +968,7 @@ ___
### retrieveInventoryItem
**retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\>
`**retrieveInventoryItem**(inventoryItemId, config?, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;`
#### Parameters
@@ -984,7 +984,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -993,7 +993,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1004,12 +1004,12 @@ ___
#### Returns
`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\>
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1022,7 +1022,7 @@ ___
### retrieveInventoryLevel
**retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
`**retrieveInventoryLevel**(inventoryItemId, locationId, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
#### Parameters
@@ -1047,7 +1047,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1058,12 +1058,12 @@ ___
#### Returns
`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1076,7 +1076,7 @@ ___
### retrieveReservationItem
**retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\>
`**retrieveReservationItem**(reservationId, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;`
#### Parameters
@@ -1092,7 +1092,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1103,12 +1103,12 @@ ___
#### Returns
`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\>
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1121,7 +1121,7 @@ ___
### retrieveReservedQuantity
**retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
`**retrieveReservedQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;`
#### Parameters
@@ -1146,7 +1146,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1157,12 +1157,12 @@ ___
#### Returns
`Promise`<`number`\>
Promise&#60;number&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1175,7 +1175,7 @@ ___
### retrieveStockedQuantity
**retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
`**retrieveStockedQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;`
#### Parameters
@@ -1200,7 +1200,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1211,12 +1211,12 @@ ___
#### Returns
`Promise`<`number`\>
Promise&#60;number&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1229,7 +1229,7 @@ ___
### updateInventoryItem
**updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\>
`**updateInventoryItem**(inventoryItemId, input, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;`
#### Parameters
@@ -1245,7 +1245,7 @@ ___
},
{
"name": "input",
"type": "[`CreateInventoryItemInput`](../types/CreateInventoryItemInput.mdx)",
"type": "[CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1254,7 +1254,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1265,12 +1265,12 @@ ___
#### Returns
`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\>
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryItemDTO`](../types/InventoryItemDTO.mdx)\\>",
"type": "Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1283,7 +1283,7 @@ ___
### updateInventoryLevel
**updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
`**updateInventoryLevel**(inventoryItemId, locationId, update, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
#### Parameters
@@ -1308,7 +1308,7 @@ ___
},
{
"name": "update",
"type": "[`UpdateInventoryLevelInput`](../types/UpdateInventoryLevelInput.mdx)",
"type": "[UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1317,7 +1317,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1328,12 +1328,12 @@ ___
#### Returns
`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\>
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1346,14 +1346,14 @@ ___
### updateInventoryLevels
**updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[]\>
`**updateInventoryLevels**(updates, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "updates",
"type": "{ `inventory_item_id`: `string` ; `location_id`: `string` } & [`UpdateInventoryLevelInput`](../types/UpdateInventoryLevelInput.mdx)[]",
"type": "`&#123; inventory_item_id: string ; location_id: string &#125;` & [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1362,7 +1362,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1373,12 +1373,12 @@ ___
#### Returns
`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[]\>
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`InventoryLevelDTO`](../types/InventoryLevelDTO.mdx)[]\\>",
"type": "Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1391,7 +1391,7 @@ ___
### updateReservationItem
**updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\>
`**updateReservationItem**(reservationItemId, input, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;`
#### Parameters
@@ -1407,7 +1407,7 @@ ___
},
{
"name": "input",
"type": "[`UpdateReservationItemInput`](../types/UpdateReservationItemInput.mdx)",
"type": "[UpdateReservationItemInput](../types/UpdateReservationItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1416,7 +1416,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1427,12 +1427,12 @@ ___
#### Returns
`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\>
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReservationItemDTO`](../types/ReservationItemDTO.mdx)\\>",
"type": "Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/INotificationService.mdx
+25 -25
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -60,16 +60,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -82,7 +82,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -114,7 +114,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -132,7 +132,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -143,12 +143,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -161,7 +161,7 @@ ___
### resendNotification
**resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
`**resendNotification**(notification, config, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
@@ -197,12 +197,12 @@ ___
#### Returns
`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\\>",
"type": "Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -215,7 +215,7 @@ ___
### sendNotification
**sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
`**sendNotification**(event, data, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
@@ -251,12 +251,12 @@ ___
#### Returns
`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\>
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ReturnedData`](../types/ReturnedData.mdx)\\>",
"type": "Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -269,14 +269,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -305,14 +305,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`INotificationService`](INotificationService.mdx)
`**withTransaction**(transactionManager?): [INotificationService](INotificationService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -323,12 +323,12 @@ ___
#### Returns
[`INotificationService`](INotificationService.mdx)
[INotificationService](INotificationService.mdx)
<ParameterTypes parameters={[
{
"name": "INotificationService",
"type": "[`INotificationService`](INotificationService.mdx)",
"type": "[INotificationService](INotificationService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx
+12 -12
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### calculateVariantPrice
**calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../types/PriceSelectionResult.mdx)\>\>
`**calculateVariantPrice**(data, context): Promise&#60;Map&#60;string, [PriceSelectionResult](../types/PriceSelectionResult.mdx)&#62;&#62;`
Calculate the original and discount price for a given variant in a set of
circumstances described in the context.
@@ -20,7 +20,7 @@ circumstances described in the context.
<ParameterTypes parameters={[
{
"name": "data",
"type": "{ `quantity?`: `number` ; `variantId`: `string` }[]",
"type": "`&#123; quantity?: number ; variantId: string &#125;`[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -29,7 +29,7 @@ circumstances described in the context.
},
{
"name": "context",
"type": "[`PriceSelectionContext`](../types/PriceSelectionContext.mdx)",
"type": "[PriceSelectionContext](../types/PriceSelectionContext.mdx)",
"description": "Details relevant to determine the correct pricing of the variant",
"optional": false,
"defaultValue": "",
@@ -40,12 +40,12 @@ circumstances described in the context.
#### Returns
`Promise`<`Map`<`string`, [`PriceSelectionResult`](../types/PriceSelectionResult.mdx)\>\>
Promise&#60;Map&#60;string, [PriceSelectionResult](../types/PriceSelectionResult.mdx)&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`Map`<`string`, [`PriceSelectionResult`](../types/PriceSelectionResult.mdx)\\>\\>",
"type": "Promise&#60;Map&#60;string, [PriceSelectionResult](../types/PriceSelectionResult.mdx)&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "pricing details in an object containing the calculated lowest price,\nthe default price an all valid prices for the given variant",
@@ -58,7 +58,7 @@ ___
### onVariantsPricesUpdate
**onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\>
`**onVariantsPricesUpdate**(variantIds): Promise&#60;void&#62;`
Notify price selection strategy that variants prices have been updated.
@@ -78,12 +78,12 @@ Notify price selection strategy that variants prices have been updated.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -96,14 +96,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](IPriceSelectionStrategy.mdx)
`**withTransaction**(transactionManager?): [IPriceSelectionStrategy](IPriceSelectionStrategy.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -114,12 +114,12 @@ ___
#### Returns
[`IPriceSelectionStrategy`](IPriceSelectionStrategy.mdx)
[IPriceSelectionStrategy](IPriceSelectionStrategy.mdx)
<ParameterTypes parameters={[
{
"name": "IPriceSelectionStrategy",
"type": "[`IPriceSelectionStrategy`](IPriceSelectionStrategy.mdx)",
"type": "[IPriceSelectionStrategy](IPriceSelectionStrategy.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IPricingModuleService.mdx
+229 -229
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/services/interfaces/ISearchService.mdx
+9 -9
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "options",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addDocuments
**addDocuments**(`indexName`, `documents`, `type`): `unknown`
`**addDocuments**(indexName, documents, type): unknown`
Used to index documents by the search engine provider
@@ -80,7 +80,7 @@ ___
### createIndex
**createIndex**(`indexName`, `options`): `unknown`
`**createIndex**(indexName, options): unknown`
Used to create an index
@@ -127,7 +127,7 @@ ___
### deleteAllDocuments
**deleteAllDocuments**(`indexName`): `unknown`
`**deleteAllDocuments**(indexName): unknown`
Used to delete all documents
@@ -165,7 +165,7 @@ ___
### deleteDocument
**deleteDocument**(`indexName`, `document_id`): `unknown`
`**deleteDocument**(indexName, document_id): unknown`
Used to delete document
@@ -212,7 +212,7 @@ ___
### getIndex
**getIndex**(`indexName`): `unknown`
`**getIndex**(indexName): unknown`
Used to get an index
@@ -250,7 +250,7 @@ ___
### replaceDocuments
**replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
`**replaceDocuments**(indexName, documents, type): unknown`
Used to replace documents
@@ -306,7 +306,7 @@ ___
### search
**search**(`indexName`, `query`, `options`): `unknown`
`**search**(indexName, query, options): unknown`
Used to search for a document in an index
@@ -362,7 +362,7 @@ ___
### updateSettings
**updateSettings**(`indexName`, `settings`): `unknown`
`**updateSettings**(indexName, settings): unknown`
Used to update the settings of an index
www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx
+34 -34
View File
@@ -10,16 +10,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_joinerConfig
**__joinerConfig**(): [`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)
`**__joinerConfig**(): [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)`
#### Returns
[`ModuleJoinerConfig`](../types/ModuleJoinerConfig.mdx)
[ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../types/Omit.mdx)<[`JoinerServiceConfig`](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`](../types/ModuleJoinerRelationship.mdx) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../types/ModuleJoinerRelationship.mdx)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"type": "[Omit](../types/Omit.mdx)&#60;[JoinerServiceConfig](JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../types/ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -32,14 +32,14 @@ ___
### create
**create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
`**create**(input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "[`CreateStockLocationInput`](../types/CreateStockLocationInput.mdx)",
"type": "[CreateStockLocationInput](../types/CreateStockLocationInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -59,12 +59,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -77,7 +77,7 @@ ___
### delete
**delete**(`id`, `context?`): `Promise`<`void`\>
`**delete**(id, context?): Promise&#60;void&#62;`
#### Parameters
@@ -93,7 +93,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -104,12 +104,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -122,14 +122,14 @@ ___
### list
**list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\>
`**list**(selector, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx)",
"type": "[FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -147,7 +147,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -158,12 +158,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)[]\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -176,14 +176,14 @@ ___
### listAndCount
**listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\>
`**listAndCount**(selector, config?, context?): Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`FilterableStockLocationProps`](../types/FilterableStockLocationProps.mdx)",
"type": "[FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -201,7 +201,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -212,12 +212,12 @@ ___
#### Returns
`Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\>
Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`StockLocationDTO`](../types/StockLocationDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -230,7 +230,7 @@ ___
### retrieve
**retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
`**retrieve**(id, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
#### Parameters
@@ -246,7 +246,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](FindConfig-1.mdx)<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "[FindConfig](FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -255,7 +255,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -266,12 +266,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -284,7 +284,7 @@ ___
### update
**update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
`**update**(id, input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
#### Parameters
@@ -300,7 +300,7 @@ ___
},
{
"name": "input",
"type": "[`UpdateStockLocationInput`](../types/UpdateStockLocationInput.mdx)",
"type": "[UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ ___
},
{
"name": "context",
"type": "[`SharedContext`](../types/SharedContext.mdx)",
"type": "[SharedContext](../types/SharedContext.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -320,12 +320,12 @@ ___
#### Returns
`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\>
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`StockLocationDTO`](../types/StockLocationDTO.mdx)\\>",
"type": "Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/ITaxCalculationStrategy.mdx
+6 -6
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### calculate
**calculate**(`items`, `taxLines`, `calculationContext`): `Promise`<`number`\>
`**calculate**(items, taxLines, calculationContext): Promise&#60;number&#62;`
Calculates the tax amount for a given set of line items under applicable
tax conditions and calculation contexts.
@@ -20,7 +20,7 @@ tax conditions and calculation contexts.
<ParameterTypes parameters={[
{
"name": "items",
"type": "[`LineItem`](../classes/LineItem.mdx)[]",
"type": "[LineItem](../classes/LineItem.mdx)[]",
"description": "the line items to calculate the tax total for",
"optional": false,
"defaultValue": "",
@@ -29,7 +29,7 @@ tax conditions and calculation contexts.
},
{
"name": "taxLines",
"type": "([`LineItemTaxLine`](../classes/LineItemTaxLine.mdx) \\| [`ShippingMethodTaxLine`](../classes/ShippingMethodTaxLine.mdx))[]",
"type": "([LineItemTaxLine](../classes/LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../classes/ShippingMethodTaxLine.mdx))[]",
"description": "the tax lines that applies to the calculation",
"optional": false,
"defaultValue": "",
@@ -38,7 +38,7 @@ tax conditions and calculation contexts.
},
{
"name": "calculationContext",
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
"description": "other details relevant for the calculation",
"optional": false,
"defaultValue": "",
@@ -49,12 +49,12 @@ tax conditions and calculation contexts.
#### Returns
`Promise`<`number`\>
Promise&#60;number&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`number`\\>",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "the tax total",
www/apps/docs/content/references/services/interfaces/ITaxService.mdx
+6 -6
View File
@@ -14,7 +14,7 @@ items and shipping methods.
### getTaxLines
**getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../types/ProviderTaxLine.mdx)[]\>
`**getTaxLines**(itemLines, shippingLines, context): Promise&#60;[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]&#62;`
Retrieves the numerical tax lines for a calculation context.
@@ -23,7 +23,7 @@ Retrieves the numerical tax lines for a calculation context.
<ParameterTypes parameters={[
{
"name": "itemLines",
"type": "[`ItemTaxCalculationLine`](../types/ItemTaxCalculationLine.mdx)[]",
"type": "[ItemTaxCalculationLine](../types/ItemTaxCalculationLine.mdx)[]",
"description": "the line item calculation lines",
"optional": false,
"defaultValue": "",
@@ -32,7 +32,7 @@ Retrieves the numerical tax lines for a calculation context.
},
{
"name": "shippingLines",
"type": "[`ShippingTaxCalculationLine`](../types/ShippingTaxCalculationLine.mdx)[]",
"type": "[ShippingTaxCalculationLine](../types/ShippingTaxCalculationLine.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -41,7 +41,7 @@ Retrieves the numerical tax lines for a calculation context.
},
{
"name": "context",
"type": "[`TaxCalculationContext`](../types/TaxCalculationContext.mdx)",
"type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
"description": "other details relevant to the tax determination",
"optional": false,
"defaultValue": "",
@@ -52,12 +52,12 @@ Retrieves the numerical tax lines for a calculation context.
#### Returns
`Promise`<[`ProviderTaxLine`](../types/ProviderTaxLine.mdx)[]\>
Promise&#60;[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ProviderTaxLine`](../types/ProviderTaxLine.mdx)[]\\>",
"type": "Promise&#60;[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "numerical tax rates that should apply to the provided calculation\n lines",
www/apps/docs/content/references/services/interfaces/ITransactionBaseService.mdx
+4 -4
View File
@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### withTransaction
**withTransaction**(`transactionManager?`): [`ITransactionBaseService`](ITransactionBaseService.mdx)
`**withTransaction**(transactionManager?): [ITransactionBaseService](ITransactionBaseService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -28,12 +28,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
[`ITransactionBaseService`](ITransactionBaseService.mdx)
[ITransactionBaseService](ITransactionBaseService.mdx)
<ParameterTypes parameters={[
{
"name": "ITransactionBaseService",
"type": "[`ITransactionBaseService`](ITransactionBaseService.mdx)",
"type": "[ITransactionBaseService](ITransactionBaseService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/IterableIterator.mdx
+12 -12
View File
@@ -24,16 +24,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### [iterator]
**[iterator]**(): [`IterableIterator`](IterableIterator.mdx)<`T`\>
`**[iterator]**(): [IterableIterator](IterableIterator.mdx)&#60;T&#62;`
#### Returns
[`IterableIterator`](IterableIterator.mdx)<`T`\>
[IterableIterator](IterableIterator.mdx)&#60;T&#62;
<ParameterTypes parameters={[
{
"name": "IterableIterator",
"type": "[`IterableIterator`](IterableIterator.mdx)<`T`\\>",
"type": "[IterableIterator](IterableIterator.mdx)&#60;T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -46,7 +46,7 @@ ___
### next
**next**(`...args`): [`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\>
`**next**(...args): [IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;`
#### Parameters
@@ -64,12 +64,12 @@ ___
#### Returns
[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\>
[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\\>",
"type": "[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -82,7 +82,7 @@ ___
### return
`Optional` **return**(`value?`): [`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\>
`Optional **return**(value?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;`
#### Parameters
@@ -100,12 +100,12 @@ ___
#### Returns
[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\>
[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\\>",
"type": "[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -118,7 +118,7 @@ ___
### throw
`Optional` **throw**(`e?`): [`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\>
`Optional **throw**(e?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;`
#### Parameters
@@ -136,12 +136,12 @@ ___
#### Returns
[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\>
[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `any`\\>",
"type": "[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/Iterator.mdx
+9 -9
View File
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### next
**next**(`...args`): [`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\>
`**next**(...args): [IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;`
#### Parameters
@@ -60,12 +60,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
#### Returns
[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\>
[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\\>",
"type": "[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -78,7 +78,7 @@ ___
### return
`Optional` **return**(`value?`): [`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\>
`Optional **return**(value?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;`
#### Parameters
@@ -96,12 +96,12 @@ ___
#### Returns
[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\>
[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\\>",
"type": "[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -114,7 +114,7 @@ ___
### throw
`Optional` **throw**(`e?`): [`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\>
`Optional **throw**(e?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;`
#### Parameters
@@ -132,12 +132,12 @@ ___
#### Returns
[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\>
[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;
<ParameterTypes parameters={[
{
"name": "IteratorResult",
"type": "[`IteratorResult`](../types/IteratorResult.mdx)<`T`, `TReturn`\\>",
"type": "[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/JoinerServiceConfig.mdx
+6 -6
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx)[]",
"type": "[JoinerServiceConfigAlias](JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]",
"type": "`&#123; relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,8 +38,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "fieldAlias",
"type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>",
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"type": "`Record<string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;>`",
"description": "alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "relationships",
"type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]",
"type": "[JoinerRelationship](../types/JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/JoinerServiceConfigAlias.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/PaymentProcessor.mdx
+42 -42
View File
@@ -13,7 +13,7 @@ This work is still experimental and can be changed until it becomes stable
### authorizePayment
**authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/PaymentSessionStatus.mdx) }\>
`**authorizePayment**(paymentSessionData, context): Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| &#123; data: Record&#60;string, unknown&#62; ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) &#125;&#62;`
Authorize an existing session if it is not already authorized
@@ -22,7 +22,7 @@ Authorize an existing session if it is not already authorized
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ Authorize an existing session if it is not already authorized
},
{
"name": "context",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -42,12 +42,12 @@ Authorize an existing session if it is not already authorized
#### Returns
`Promise`<[`PaymentProcessorError`](PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/PaymentSessionStatus.mdx) }\>
Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| &#123; data: Record&#60;string, unknown&#62; ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) &#125;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PaymentProcessorError`](PaymentProcessorError.mdx) \\| { `data`: Record<`string`, `unknown`\\> ; `status`: [`PaymentSessionStatus`](../enums/PaymentSessionStatus.mdx) }\\>",
"type": "Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \\| &#123; data: Record&#60;string, unknown&#62; ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) &#125;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -60,7 +60,7 @@ ___
### cancelPayment
**cancelPayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
`**cancelPayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Cancel an existing session
@@ -69,7 +69,7 @@ Cancel an existing session
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -80,12 +80,12 @@ Cancel an existing session
#### Returns
`Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](PaymentProcessorError.mdx)\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62; \\| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -98,7 +98,7 @@ ___
### capturePayment
**capturePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
`**capturePayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Capture an existing session
@@ -107,7 +107,7 @@ Capture an existing session
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -118,12 +118,12 @@ Capture an existing session
#### Returns
`Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](PaymentProcessorError.mdx)\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62; \\| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -136,7 +136,7 @@ ___
### deletePayment
**deletePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
`**deletePayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Delete an existing session
@@ -145,7 +145,7 @@ Delete an existing session
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -156,12 +156,12 @@ Delete an existing session
#### Returns
`Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](PaymentProcessorError.mdx)\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62; \\| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -174,7 +174,7 @@ ___
### getIdentifier
**getIdentifier**(): `string`
`**getIdentifier**(): string`
Return a unique identifier to retrieve the payment plugin provider
@@ -198,7 +198,7 @@ ___
### getPaymentStatus
**getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/PaymentSessionStatus.mdx)\>
`**getPaymentStatus**(paymentSessionData): Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;`
Return the status of the session
@@ -207,7 +207,7 @@ Return the status of the session
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -218,12 +218,12 @@ Return the status of the session
#### Returns
`Promise`<[`PaymentSessionStatus`](../enums/PaymentSessionStatus.mdx)\>
Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PaymentSessionStatus`](../enums/PaymentSessionStatus.mdx)\\>",
"type": "Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -236,7 +236,7 @@ ___
### initiatePayment
**initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../types/PaymentProcessorSessionResponse.mdx)\>
`**initiatePayment**(context): Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;`
Initiate a payment session with the external provider
@@ -245,7 +245,7 @@ Initiate a payment session with the external provider
<ParameterTypes parameters={[
{
"name": "context",
"type": "[`PaymentProcessorContext`](../types/PaymentProcessorContext.mdx)",
"type": "[PaymentProcessorContext](../types/PaymentProcessorContext.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -256,12 +256,12 @@ Initiate a payment session with the external provider
#### Returns
`Promise`<[`PaymentProcessorError`](PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../types/PaymentProcessorSessionResponse.mdx)\>
Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PaymentProcessorError`](PaymentProcessorError.mdx) \\| [`PaymentProcessorSessionResponse`](../types/PaymentProcessorSessionResponse.mdx)\\>",
"type": "Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \\| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -274,7 +274,7 @@ ___
### refundPayment
**refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
`**refundPayment**(paymentSessionData, refundAmount): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Refund an existing session
@@ -283,7 +283,7 @@ Refund an existing session
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -303,12 +303,12 @@ Refund an existing session
#### Returns
`Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](PaymentProcessorError.mdx)\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62; \\| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -321,7 +321,7 @@ ___
### retrievePayment
**retrievePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
`**retrievePayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Retrieve an existing session
@@ -330,7 +330,7 @@ Retrieve an existing session
<ParameterTypes parameters={[
{
"name": "paymentSessionData",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -341,12 +341,12 @@ Retrieve an existing session
#### Returns
`Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](PaymentProcessorError.mdx)\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62; \\| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -359,7 +359,7 @@ ___
### updatePayment
**updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../types/PaymentProcessorSessionResponse.mdx)\>
`**updatePayment**(context): Promise&#60;void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;`
Update an existing payment session
@@ -368,7 +368,7 @@ Update an existing payment session
<ParameterTypes parameters={[
{
"name": "context",
"type": "[`PaymentProcessorContext`](../types/PaymentProcessorContext.mdx)",
"type": "[PaymentProcessorContext](../types/PaymentProcessorContext.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -379,12 +379,12 @@ Update an existing payment session
#### Returns
`Promise`<`void` \| [`PaymentProcessorError`](PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../types/PaymentProcessorSessionResponse.mdx)\>
Promise&#60;void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`PaymentProcessorError`](PaymentProcessorError.mdx) \\| [`PaymentProcessorSessionResponse`](../types/PaymentProcessorSessionResponse.mdx)\\>",
"type": "Promise&#60;void \\| [PaymentProcessorError](PaymentProcessorError.mdx) \\| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -397,7 +397,7 @@ ___
### updatePaymentData
**updatePaymentData**(`sessionId`, `data`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
`**updatePaymentData**(sessionId, data): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Update the session data for a payment session
@@ -415,7 +415,7 @@ Update the session data for a payment session
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -426,12 +426,12 @@ Update the session data for a payment session
#### Returns
`Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](PaymentProcessorError.mdx)\>
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](PaymentProcessorError.mdx)\\>",
"type": "Promise&#60;Record&#60;string, unknown&#62; \\| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/interfaces/PriceRuleDTO.mdx
+2 -2
View File
@@ -31,7 +31,7 @@ A price rule's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A price rule's data.
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/PriceSetDTO.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ A price set's data.
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -31,7 +31,7 @@ A price set's data.
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountDTO.mdx
+3 -3
View File
@@ -22,7 +22,7 @@ A price set money amount's data.
},
{
"name": "money_amount",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"optional": true,
"defaultValue": "",
@@ -31,7 +31,7 @@ A price set money amount's data.
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountRulesDTO.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ A price set money amount rule's data.
},
{
"name": "price_set_money_amount",
"type": "[`PriceSetMoneyAmountDTO`](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ A price set money amount rule's data.
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/PricingContext.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ The context to calculate prices. For example, you can specify the currency code
<ParameterTypes parameters={[
{
"name": "context",
"type": "Record<`string`, `string` \\| `number`\\>",
"type": "`Record<string, string \\| number>`",
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in. Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/RemoteJoinerQuery.mdx
+2 -2
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "[`JoinerArgument`](JoinerArgument.mdx)[]",
"type": "[JoinerArgument](JoinerArgument.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "expands",
"type": "{ `args?`: [`JoinerArgument`](JoinerArgument.mdx)[] ; `directives?`: { `[field: string]`: [`JoinerDirective`](JoinerDirective.mdx)[]; } ; `fields`: `string`[] ; `property`: `string` }[]",
"type": "`&#123; args?: [JoinerArgument](JoinerArgument.mdx)[] ; directives?: &#123; [field: string]: [JoinerDirective](JoinerDirective.mdx)[]; &#125; ; fields: string[] ; property: string &#125;`[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/RuleTypeDTO.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ A rule type's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx
+4 -4
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "[species]",
"type": "[`SharedArrayBuffer`](../index.md#sharedarraybuffer)",
"type": "[SharedArrayBuffer](../index.md#sharedarraybuffer)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### slice
**slice**(`begin`, `end?`): [`SharedArrayBuffer`](../index.md#sharedarraybuffer)
`**slice**(begin, end?): [SharedArrayBuffer](../index.md#sharedarraybuffer)`
Returns a section of an SharedArrayBuffer.
@@ -71,12 +71,12 @@ Returns a section of an SharedArrayBuffer.
#### Returns
[`SharedArrayBuffer`](../index.md#sharedarraybuffer)
[SharedArrayBuffer](../index.md#sharedarraybuffer)
<ParameterTypes parameters={[
{
"name": "SharedArrayBuffer",
"type": "[`SharedArrayBufferConstructor`](SharedArrayBufferConstructor.mdx)",
"type": "[SharedArrayBufferConstructor](SharedArrayBufferConstructor.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/SharedArrayBufferConstructor.mdx
+2 -2
View File
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new SharedArrayBufferConstructor**(`byteLength`)
`**new SharedArrayBufferConstructor**(byteLength)`
#### Parameters
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "prototype",
"type": "[`SharedArrayBuffer`](../index.md#sharedarraybuffer)",
"type": "[SharedArrayBuffer](../index.md#sharedarraybuffer)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/interfaces/UpdateRuleTypeDTO.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ The data to update in a rule type. The `id` is used to identify which price set
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/services/interfaces/UpdateUserInput.mdx
+2 -2
View File
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "role",
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
"type": "[UserRoles](../enums/UserRoles.mdx)",
"description": "",
"optional": true,
"defaultValue": "",