chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

View File

@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### valueOf
#### valueOf
`**valueOf**(): boolean`
Returns the primitive value of the specified object.
#### Returns
##### Returns
`boolean`

View File

@@ -12,13 +12,13 @@ Valid string encodings: 'ascii'\|'utf8'\|'utf16le'\|'ucs2'(alias of 'utf16le')\|
## Constructors
### constructor
#### constructor
`**new BufferConstructor**(str, encoding?)`
Allocates a new buffer containing the given &#123;str&#125;.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ since v10.0.0 - Use `Buffer.from(string[, encoding])` instead.
Allocates a new buffer of &#123;size&#125; octets.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -71,7 +71,7 @@ since v10.0.0 - Use `Buffer.alloc()` instead (also see `Buffer.allocUnsafe()`).
Allocates a new buffer containing the given &#123;array&#125; of octets.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -94,7 +94,7 @@ since v10.0.0 - Use `Buffer.from(array)` instead.
Produces a Buffer backed by the same allocated memory as
the given &#123;ArrayBuffer&#125;/&#123;SharedArrayBuffer&#125;.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -116,7 +116,7 @@ since v10.0.0 - Use `Buffer.from(arrayBuffer[, byteOffset[, length]])` instead.
Allocates a new buffer containing the given &#123;array&#125; of octets.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -138,7 +138,7 @@ since v10.0.0 - Use `Buffer.from(array)` instead.
Copies the passed &#123;buffer&#125; data onto a new &#123;Buffer&#125; instance.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -172,7 +172,7 @@ since v10.0.0 - Use `Buffer.from(buffer)` instead.
## Methods
### alloc
#### alloc
`**alloc**(size, fill?, encoding?): [Buffer](../index.md#buffer)`
@@ -218,7 +218,7 @@ data that might not have been allocated for `Buffer`s.
A `TypeError` will be thrown if `size` is not a number.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -250,7 +250,7 @@ A `TypeError` will be thrown if `size` is not a number.
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -272,7 +272,7 @@ v5.10.0
___
### allocUnsafe
#### allocUnsafe
`**allocUnsafe**(size): [Buffer](../index.md#buffer)`
@@ -308,7 +308,7 @@ 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.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -322,7 +322,7 @@ additional performance that `Buffer.allocUnsafe()` provides.
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -344,7 +344,7 @@ v5.10.0
___
### allocUnsafeSlow
#### allocUnsafeSlow
`**allocUnsafeSlow**(size): [Buffer](../index.md#buffer)`
@@ -389,7 +389,7 @@ socket.on('readable', () => {
A `TypeError` will be thrown if `size` is not a number.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -403,7 +403,7 @@ A `TypeError` will be thrown if `size` is not a number.
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -425,7 +425,7 @@ v5.12.0
___
### byteLength
#### byteLength
`**byteLength**(string, encoding?): number`
@@ -453,7 +453,7 @@ When `string` is a
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
##### Parameters
<ParameterTypes parameters={[
{
@@ -476,7 +476,7 @@ er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/SharedArrayBu
}
]} />
#### Returns
##### Returns
`number`
@@ -498,7 +498,7 @@ v0.1.90
___
### compare
#### compare
`**compare**(buf1, buf2): 0 \| 1 \| -1`
@@ -516,7 +516,7 @@ console.log(arr.sort(Buffer.compare));
// (This result is equal to: [buf2, buf1].)
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -539,7 +539,7 @@ console.log(arr.sort(Buffer.compare));
}
]} />
#### Returns
##### Returns
`0` \| `1` \| `-1`
@@ -561,7 +561,7 @@ v0.11.13
___
### concat
#### concat
`**concat**(list, totalLength?): [Buffer](../index.md#buffer)`
@@ -599,7 +599,7 @@ console.log(bufA.length);
`Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -622,7 +622,7 @@ console.log(bufA.length);
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -644,7 +644,7 @@ v0.7.11
___
### copyBytesFrom
#### copyBytesFrom
`**copyBytesFrom**(view, offset?, length?): [Buffer](../index.md#buffer)`
@@ -659,7 +659,7 @@ console.log(buf[0]); // 255
console.log(buf[1]); // 255
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -691,7 +691,7 @@ console.log(buf[1]); // 255
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -713,7 +713,7 @@ v19.8.0
___
### from
#### from
`**from**(arrayBuffer, byteOffset?, length?): [Buffer](../index.md#buffer)`
@@ -736,7 +736,7 @@ appropriate for `Buffer.from()` variants.
`Buffer.from(array)` and `Buffer.from(string)` may also use the internal`Buffer` pool like `Buffer.allocUnsafe()` does.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -768,7 +768,7 @@ appropriate for `Buffer.from()` variants.
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -792,7 +792,7 @@ v5.10.0
Creates a new Buffer using the passed &#123;data&#125;
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -806,7 +806,7 @@ Creates a new Buffer using the passed &#123;data&#125;
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -824,7 +824,7 @@ Creates a new Buffer using the passed &#123;data&#125;
`**from**(data): [Buffer](../index.md#buffer)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -838,7 +838,7 @@ Creates a new Buffer using the passed &#123;data&#125;
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -860,7 +860,7 @@ 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
##### Parameters
<ParameterTypes parameters={[
{
@@ -883,7 +883,7 @@ If not provided, &#123;encoding&#125; defaults to 'utf8'.
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)
@@ -901,7 +901,7 @@ If not provided, &#123;encoding&#125; defaults to 'utf8'.
___
### isBuffer
#### isBuffer
`**isBuffer**(obj): obj is Buffer`
@@ -917,7 +917,7 @@ Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -931,7 +931,7 @@ Buffer.isBuffer(new Uint8Array(1024)); // false
}
]} />
#### Returns
##### Returns
obj is Buffer
@@ -953,7 +953,7 @@ v0.1.101
___
### isEncoding
#### isEncoding
`**isEncoding**(encoding): encoding is BufferEncoding`
@@ -976,7 +976,7 @@ console.log(Buffer.isEncoding(''));
// Prints: false
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -990,7 +990,7 @@ console.log(Buffer.isEncoding(''));
}
]} />
#### Returns
##### Returns
encoding is BufferEncoding
@@ -1012,13 +1012,13 @@ v0.9.1
___
### of
#### of
`**of**(...items): [Buffer](../index.md#buffer)`
Creates a new Buffer using the passed &#123;data&#125;
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1032,7 +1032,7 @@ Creates a new Buffer using the passed &#123;data&#125;
}
]} />
#### Returns
##### Returns
[Buffer](../index.md#buffer)

View File

@@ -0,0 +1,176 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CalculatedPriceSet
The calculated price for a specific price set and context.
## Properties
<ParameterTypes parameters={[
{
"name": "calculated_amount",
"type": "`null` \\| `number`",
"description": "The amount of the calculated price, or `null` if there isn't a calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price",
"type": "`object`",
"description": "The details of the calculated price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.max_quantity",
"type": "`null` \\| `number`",
"description": "The `max_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.min_quantity",
"type": "`null` \\| `number`",
"description": "The `min_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.money_amount_id",
"type": "`null` \\| `string`",
"description": "The ID of the money amount selected as the calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency_code",
"type": "`null` \\| `string`",
"description": "The currency code of the calculated price, or null if there isn't a calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_calculated_price_price_list",
"type": "`boolean`",
"description": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found, the calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_original_price_price_list",
"type": "`boolean`",
"description": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override, the original price will be the same as the calculated price. In that case, the value of this property is `true`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_amount",
"type": "`null` \\| `number`",
"description": "The amount of the original price, or `null` if there isn't a calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price",
"type": "`object`",
"description": "The details of the original price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.max_quantity",
"type": "`null` \\| `number`",
"description": "The `max_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.min_quantity",
"type": "`null` \\| `number`",
"description": "The `min_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.money_amount_id",
"type": "`null` \\| `string`",
"description": "The ID of the money amount selected as the original price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

View File

@@ -1,86 +0,0 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CalculatedPriceSetDTO
A calculated price set's data.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
"type": "`null` \\| `string`",
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency_code",
"type": "`null` \\| `string`",
"description": "The currency code of the calculated price. It can possibly be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "max_quantity",
"type": "`null` \\| `string`",
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`null` \\| `string`",
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

View File

@@ -7,4 +7,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListRules
The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value
* is the values of the rule.
is the values of the rule.

View File

@@ -55,7 +55,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -64,7 +64,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

View File

@@ -58,29 +58,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -88,6 +72,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -109,7 +95,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -141,7 +127,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -159,13 +145,13 @@ Promise&#60;TResult&#62;
___
### buildTemplate
#### buildTemplate
`**buildTemplate**(): Promise&#60;string&#62;`
Builds and returns a template file that can be downloaded and filled in
#### Returns
##### Returns
Promise&#60;string&#62;
@@ -183,13 +169,13 @@ Promise&#60;string&#62;
___
### preProcessBatchJob
#### preProcessBatchJob
`**preProcessBatchJob**(batchJobId): Promise&#60;void&#62;`
Method for pre-processing a batch job
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -203,7 +189,7 @@ Method for pre-processing a batch job
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -221,13 +207,13 @@ Promise&#60;void&#62;
___
### prepareBatchJobForProcessing
#### prepareBatchJobForProcessing
`**prepareBatchJobForProcessing**(batchJobEntity, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
Method for preparing a batch job for processing
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -250,7 +236,7 @@ Method for preparing a batch job for processing
}
]} />
#### Returns
##### Returns
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
@@ -268,13 +254,13 @@ Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
___
### processJob
#### processJob
`**processJob**(batchJobId): Promise&#60;void&#62;`
Method does the actual processing of the job. Should report back on the progress of the operation.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -288,7 +274,7 @@ Method does the actual processing of the job. Should report back on the progress
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -306,11 +292,11 @@ Promise&#60;void&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -324,7 +310,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -342,11 +328,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [IBatchJobStrategy](IBatchJobStrategy.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -360,7 +346,7 @@ ___
}
]} />
#### Returns
##### Returns
[IBatchJobStrategy](IBatchJobStrategy.mdx)

View File

@@ -8,10 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### get
#### get
`**get**<TypeParameter T>(key): Promise&#60;null \| T&#62;`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -24,7 +26,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -38,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
Promise&#60;null \| T&#62;
@@ -56,11 +58,11 @@ Promise&#60;null \| T&#62;
___
### invalidate
#### invalidate
`**invalidate**(key): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -74,7 +76,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -92,11 +94,11 @@ Promise&#60;void&#62;
___
### set
#### set
`**set**(key, data, ttl?): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -128,7 +130,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;

View File

@@ -8,10 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### emit
#### emit
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void&#62;`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -24,7 +26,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -74,6 +76,8 @@ Promise&#60;void&#62;
`**emit**<TypeParameter T>(data): Promise&#60;void&#62;`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -86,7 +90,7 @@ Promise&#60;void&#62;
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -100,7 +104,7 @@ Promise&#60;void&#62;
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -118,11 +122,11 @@ Promise&#60;void&#62;
___
### subscribe
#### subscribe
`**subscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -154,7 +158,7 @@ ___
}
]} />
#### Returns
##### Returns
[IEventBusModuleService](IEventBusModuleService.mdx)
@@ -172,11 +176,11 @@ ___
___
### unsubscribe
#### unsubscribe
`**unsubscribe**(eventName, subscriber, context?): [IEventBusModuleService](IEventBusModuleService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -208,7 +212,7 @@ ___
}
]} />
#### Returns
##### Returns
[IEventBusModuleService](IEventBusModuleService.mdx)

View File

@@ -8,10 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### emit
#### emit
`**emit**<TypeParameter T>(event, data, options?): Promise&#60;unknown&#62;`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -24,7 +26,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
Promise&#60;unknown&#62;
@@ -74,11 +76,11 @@ Promise&#60;unknown&#62;
___
### subscribe
#### subscribe
`**subscribe**(eventName, subscriber, context?): [IEventBusService](IEventBusService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -110,7 +112,7 @@ ___
}
]} />
#### Returns
##### Returns
[IEventBusService](IEventBusService.mdx)
@@ -128,11 +130,11 @@ ___
___
### unsubscribe
#### unsubscribe
`**unsubscribe**(eventName, subscriber, context?): [IEventBusService](IEventBusService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -164,7 +166,7 @@ ___
}
]} />
#### Returns
##### Returns
[IEventBusService](IEventBusService.mdx)
@@ -182,11 +184,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [IEventBusService](IEventBusService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -200,7 +202,7 @@ ___
}
]} />
#### Returns
##### Returns
[IEventBusService](IEventBusService.mdx)

View File

@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### adjustInventory
#### adjustInventory
`**adjustInventory**(inventoryItemId, locationId, adjustment, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
This method is used to adjust the inventory level's stocked quantity. The inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -38,7 +38,7 @@ async function adjustInventory (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -79,7 +79,7 @@ async function adjustInventory (
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
@@ -97,13 +97,13 @@ Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
___
### confirmInventory
#### confirmInventory
`**confirmInventory**(inventoryItemId, locationIds, quantity, context?): Promise&#60;boolean&#62;`
This method is used to confirm whether the specified quantity of an inventory item is available in the specified locations.
#### Example
##### Example
```ts
import {
@@ -125,7 +125,7 @@ async function confirmInventory (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -166,7 +166,7 @@ async function confirmInventory (
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -184,13 +184,13 @@ Promise&#60;boolean&#62;
___
### createInventoryItem
#### createInventoryItem
`**createInventoryItem**(input, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;`
This method is used to create an inventory item.
#### Example
##### Example
```ts
import {
@@ -211,7 +211,7 @@ async function createInventoryItem (item: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -234,7 +234,7 @@ async function createInventoryItem (item: {
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
@@ -252,13 +252,13 @@ Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
___
### createInventoryItems
#### createInventoryItems
`**createInventoryItems**(input, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;`
This method is used to create inventory items.
#### Example
##### Example
```ts
import {
@@ -279,7 +279,7 @@ async function createInventoryItems (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -302,7 +302,7 @@ async function createInventoryItems (items: {
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;
@@ -320,13 +320,13 @@ Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;
___
### createInventoryLevel
#### createInventoryLevel
`**createInventoryLevel**(data, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
This method is used to create inventory level.
#### Example
##### Example
```ts
import {
@@ -348,7 +348,7 @@ async function createInventoryLevel (item: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -371,7 +371,7 @@ async function createInventoryLevel (item: {
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
@@ -389,13 +389,13 @@ Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
___
### createInventoryLevels
#### createInventoryLevels
`**createInventoryLevels**(data, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;`
This method is used to create inventory levels.
#### Example
##### Example
```ts
import {
@@ -417,7 +417,7 @@ async function createInventoryLevels (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -440,7 +440,7 @@ async function createInventoryLevels (items: {
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;
@@ -458,13 +458,13 @@ Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;
___
### createReservationItem
#### createReservationItem
`**createReservationItem**(input, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;`
This method is used to create a reservation item.
#### Example
##### Example
```ts
import {
@@ -486,7 +486,7 @@ async function createReservationItem (item: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -509,7 +509,7 @@ async function createReservationItem (item: {
}
]} />
#### Returns
##### Returns
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
@@ -527,13 +527,13 @@ Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
___
### createReservationItems
#### createReservationItems
`**createReservationItems**(input, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;`
This method is used to create reservation items.
#### Example
##### Example
```ts
import {
@@ -555,7 +555,7 @@ async function createReservationItems (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -578,7 +578,7 @@ async function createReservationItems (items: {
}
]} />
#### Returns
##### Returns
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;
@@ -596,14 +596,14 @@ Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;
___
### deleteInventoryItem
#### deleteInventoryItem
`**deleteInventoryItem**(inventoryItemId, context?): Promise&#60;void&#62;`
This method is used to delete an inventory item or multiple inventory items. The inventory items are only soft deleted and can be restored using the
[restoreInventoryItem](IInventoryService.mdx#restoreinventoryitem) method.
#### Example
##### Example
```ts
import {
@@ -621,7 +621,7 @@ async function deleteInventoryItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -644,7 +644,7 @@ async function deleteInventoryItem (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -662,13 +662,13 @@ Promise&#60;void&#62;
___
### deleteInventoryItemLevelByLocationId
#### deleteInventoryItemLevelByLocationId
`**deleteInventoryItemLevelByLocationId**(locationId, context?): Promise&#60;void&#62;`
This method deletes the inventory item level(s) for the ID(s) of associated location(s).
#### Example
##### Example
```ts
import {
@@ -686,7 +686,7 @@ async function deleteInventoryItemLevelByLocationId (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -709,7 +709,7 @@ async function deleteInventoryItemLevelByLocationId (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -727,13 +727,13 @@ Promise&#60;void&#62;
___
### deleteInventoryLevel
#### deleteInventoryLevel
`**deleteInventoryLevel**(inventoryItemId, locationId, context?): Promise&#60;void&#62;`
This method is used to delete an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -753,7 +753,7 @@ async function deleteInventoryLevel (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -785,7 +785,7 @@ async function deleteInventoryLevel (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -803,13 +803,13 @@ Promise&#60;void&#62;
___
### deleteReservationItem
#### deleteReservationItem
`**deleteReservationItem**(reservationItemId, context?): Promise&#60;void&#62;`
This method is used to delete a reservation item or multiple reservation items by their IDs.
#### Example
##### Example
```ts
import {
@@ -827,7 +827,7 @@ async function deleteReservationItems (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -850,7 +850,7 @@ async function deleteReservationItems (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -868,13 +868,13 @@ Promise&#60;void&#62;
___
### deleteReservationItemByLocationId
#### deleteReservationItemByLocationId
`**deleteReservationItemByLocationId**(locationId, context?): Promise&#60;void&#62;`
This method deletes reservation item(s) by the ID(s) of associated location(s).
#### Example
##### Example
```ts
import {
@@ -892,7 +892,7 @@ async function deleteReservationItemByLocationId (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -915,7 +915,7 @@ async function deleteReservationItemByLocationId (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -933,13 +933,13 @@ Promise&#60;void&#62;
___
### deleteReservationItemsByLineItem
#### deleteReservationItemsByLineItem
`**deleteReservationItemsByLineItem**(lineItemId, context?): Promise&#60;void&#62;`
This method is used to delete the reservation items associated with a line item or multiple line items.
#### Example
##### Example
```ts
import {
@@ -957,7 +957,7 @@ async function deleteReservationItemsByLineItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -980,7 +980,7 @@ async function deleteReservationItemsByLineItem (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -998,13 +998,13 @@ Promise&#60;void&#62;
___
### listInventoryItems
#### listInventoryItems
`**listInventoryItems**(selector, config?, context?): Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;`
This method is used to retrieve a paginated list of inventory items along with the total count of available inventory items satisfying the provided filters.
#### Example
##### Example
To retrieve a list of inventory items using their IDs:
@@ -1066,7 +1066,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1098,7 +1098,7 @@ async function retrieveInventoryItems (ids: string[], skip: number, take: number
}
]} />
#### Returns
##### Returns
Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;
@@ -1116,13 +1116,13 @@ Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;
___
### listInventoryLevels
#### listInventoryLevels
`**listInventoryLevels**(selector, config?, context?): Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;`
This method is used to retrieve a paginated list of inventory levels along with the total count of available inventory levels satisfying the provided filters.
#### Example
##### Example
To retrieve a list of inventory levels using their IDs:
@@ -1184,7 +1184,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1216,7 +1216,7 @@ async function retrieveInventoryLevels (inventoryItemIds: string[], skip: number
}
]} />
#### Returns
##### Returns
Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;
@@ -1234,13 +1234,13 @@ Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;
___
### listReservationItems
#### listReservationItems
`**listReservationItems**(selector, config?, context?): Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;`
This method is used to retrieve a paginated list of reservation items along with the total count of available reservation items satisfying the provided filters.
#### Example
##### Example
To retrieve a list of reservation items using their IDs:
@@ -1302,7 +1302,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1334,7 +1334,7 @@ async function retrieveReservationItems (ids: string[], skip: number, take: numb
}
]} />
#### Returns
##### Returns
Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;
@@ -1352,13 +1352,13 @@ Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#6
___
### restoreInventoryItem
#### restoreInventoryItem
`**restoreInventoryItem**(inventoryItemId, context?): Promise&#60;void&#62;`
This method is used to restore an inventory item or multiple inventory items that were previously deleted using the [deleteInventoryItem](IInventoryService.mdx#deleteinventoryitem) method.
#### Example
##### Example
```ts
import {
@@ -1376,7 +1376,7 @@ async function restoreInventoryItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1399,7 +1399,7 @@ async function restoreInventoryItem (
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -1417,13 +1417,13 @@ Promise&#60;void&#62;
___
### retrieveAvailableQuantity
#### retrieveAvailableQuantity
`**retrieveAvailableQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;`
This method is used to retrieve the available quantity of an inventory item within the specified locations.
#### Example
##### Example
```ts
import {
@@ -1445,7 +1445,7 @@ async function retrieveAvailableQuantity (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1477,7 +1477,7 @@ async function retrieveAvailableQuantity (
}
]} />
#### Returns
##### Returns
Promise&#60;number&#62;
@@ -1495,13 +1495,13 @@ Promise&#60;number&#62;
___
### retrieveInventoryItem
#### retrieveInventoryItem
`**retrieveInventoryItem**(inventoryItemId, config?, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;`
This method is used to retrieve an inventory item by its ID
#### Example
##### Example
A simple example that retrieves a inventory item by its ID:
@@ -1537,7 +1537,7 @@ async function retrieveInventoryItem (id: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1569,7 +1569,7 @@ async function retrieveInventoryItem (id: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
@@ -1587,13 +1587,13 @@ Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
___
### retrieveInventoryLevel
#### retrieveInventoryLevel
`**retrieveInventoryLevel**(inventoryItemId, locationId, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
This method is used to retrieve an inventory level for an inventory item and a location.
#### Example
##### Example
```ts
import {
@@ -1615,7 +1615,7 @@ async function retrieveInventoryLevel (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1647,7 +1647,7 @@ async function retrieveInventoryLevel (
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
@@ -1665,13 +1665,13 @@ Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
___
### retrieveReservationItem
#### retrieveReservationItem
`**retrieveReservationItem**(reservationId, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;`
This method is used to retrieve a reservation item by its ID.
#### Example
##### Example
```ts
import {
@@ -1687,7 +1687,7 @@ async function retrieveReservationItem (id: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1710,7 +1710,7 @@ async function retrieveReservationItem (id: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
@@ -1728,13 +1728,13 @@ Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;
___
### retrieveReservedQuantity
#### retrieveReservedQuantity
`**retrieveReservedQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;`
This method is used to retrieve the reserved quantity of an inventory item within the specified locations.
#### Example
##### Example
```ts
import {
@@ -1756,7 +1756,7 @@ async function retrieveReservedQuantity (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1788,7 +1788,7 @@ async function retrieveReservedQuantity (
}
]} />
#### Returns
##### Returns
Promise&#60;number&#62;
@@ -1806,13 +1806,13 @@ Promise&#60;number&#62;
___
### retrieveStockedQuantity
#### retrieveStockedQuantity
`**retrieveStockedQuantity**(inventoryItemId, locationIds, context?): Promise&#60;number&#62;`
This method is used to retrieve the stocked quantity of an inventory item within the specified locations.
#### Example
##### Example
```ts
import {
@@ -1834,7 +1834,7 @@ async function retrieveStockedQuantity (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1866,7 +1866,7 @@ async function retrieveStockedQuantity (
}
]} />
#### Returns
##### Returns
Promise&#60;number&#62;
@@ -1884,13 +1884,13 @@ Promise&#60;number&#62;
___
### updateInventoryItem
#### updateInventoryItem
`**updateInventoryItem**(inventoryItemId, input, context?): Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;`
This method is used to update an inventory item.
#### Example
##### Example
```ts
import {
@@ -1914,7 +1914,7 @@ async function updateInventoryItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1946,7 +1946,7 @@ async function updateInventoryItem (
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
@@ -1964,13 +1964,13 @@ Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;
___
### updateInventoryLevel
#### updateInventoryLevel
`**updateInventoryLevel**(inventoryItemId, locationId, update, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;`
This method is used to update an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -1996,7 +1996,7 @@ async function updateInventoryLevel (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -2037,7 +2037,7 @@ async function updateInventoryLevel (
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
@@ -2055,13 +2055,13 @@ Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;
___
### updateInventoryLevels
#### updateInventoryLevels
`**updateInventoryLevels**(updates, context?): Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;`
This method is used to update inventory levels. Each inventory level is identified by the IDs of its associated inventory item and location.
#### Example
##### Example
```ts
import {
@@ -2083,7 +2083,7 @@ async function updateInventoryLevels (items: {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -2106,7 +2106,7 @@ async function updateInventoryLevels (items: {
}
]} />
#### Returns
##### Returns
Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;
@@ -2124,13 +2124,13 @@ Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;
___
### updateReservationItem
#### updateReservationItem
`**updateReservationItem**(reservationItemId, input, context?): Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;`
This method is used to update a reservation item.
#### Example
##### Example
```ts
import {
@@ -2154,7 +2154,7 @@ async function updateReservationItem (
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -2186,7 +2186,7 @@ async function updateReservationItem (
}
]} />
#### Returns
##### Returns
Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;

View File

@@ -58,29 +58,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -88,6 +72,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -109,7 +95,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -141,7 +127,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -159,11 +145,11 @@ Promise&#60;TResult&#62;
___
### resendNotification
#### resendNotification
`**resendNotification**(notification, config, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -195,7 +181,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
@@ -213,11 +199,11 @@ Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
___
### sendNotification
#### sendNotification
`**sendNotification**(event, data, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -249,7 +235,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
@@ -267,11 +253,11 @@ Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -285,7 +271,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -303,11 +289,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [INotificationService](INotificationService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -321,7 +307,7 @@ ___
}
]} />
#### Returns
##### Returns
[INotificationService](INotificationService.mdx)

View File

@@ -8,14 +8,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### calculateVariantPrice
#### calculateVariantPrice
`**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.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -38,7 +38,7 @@ circumstances described in the context.
}
]} />
#### Returns
##### Returns
Promise&#60;Map&#60;string, [PriceSelectionResult](../types/PriceSelectionResult.mdx)&#62;&#62;
@@ -56,13 +56,13 @@ Promise&#60;Map&#60;string, [PriceSelectionResult](../types/PriceSelectionResult
___
### onVariantsPricesUpdate
#### onVariantsPricesUpdate
`**onVariantsPricesUpdate**(variantIds): Promise&#60;void&#62;`
Notify price selection strategy that variants prices have been updated.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -76,7 +76,7 @@ Notify price selection strategy that variants prices have been updated.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -94,11 +94,11 @@ Promise&#60;void&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [IPriceSelectionStrategy](IPriceSelectionStrategy.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -112,7 +112,7 @@ ___
}
]} />
#### Returns
##### Returns
[IPriceSelectionStrategy](IPriceSelectionStrategy.mdx)

View File

@@ -22,13 +22,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### addDocuments
#### addDocuments
`**addDocuments**(indexName, documents, type): unknown`
Used to index documents by the search engine provider
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -60,7 +60,7 @@ Used to index documents by the search engine provider
}
]} />
#### Returns
##### Returns
`unknown`
@@ -78,13 +78,13 @@ Used to index documents by the search engine provider
___
### createIndex
#### createIndex
`**createIndex**(indexName, options): unknown`
Used to create an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -107,7 +107,7 @@ Used to create an index
}
]} />
#### Returns
##### Returns
`unknown`
@@ -125,13 +125,13 @@ Used to create an index
___
### deleteAllDocuments
#### deleteAllDocuments
`**deleteAllDocuments**(indexName): unknown`
Used to delete all documents
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -145,7 +145,7 @@ Used to delete all documents
}
]} />
#### Returns
##### Returns
`unknown`
@@ -163,13 +163,13 @@ Used to delete all documents
___
### deleteDocument
#### deleteDocument
`**deleteDocument**(indexName, document_id): unknown`
Used to delete document
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +192,7 @@ Used to delete document
}
]} />
#### Returns
##### Returns
`unknown`
@@ -210,13 +210,13 @@ Used to delete document
___
### getIndex
#### getIndex
`**getIndex**(indexName): unknown`
Used to get an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -230,7 +230,7 @@ Used to get an index
}
]} />
#### Returns
##### Returns
`unknown`
@@ -248,13 +248,13 @@ Used to get an index
___
### replaceDocuments
#### replaceDocuments
`**replaceDocuments**(indexName, documents, type): unknown`
Used to replace documents
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -286,7 +286,7 @@ Used to replace documents
}
]} />
#### Returns
##### Returns
`unknown`
@@ -304,13 +304,13 @@ Used to replace documents
___
### search
#### search
`**search**(indexName, query, options): unknown`
Used to search for a document in an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -342,7 +342,7 @@ Used to search for a document in an index
}
]} />
#### Returns
##### Returns
`unknown`
@@ -360,13 +360,13 @@ Used to search for a document in an index
___
### updateSettings
#### updateSettings
`**updateSettings**(indexName, settings): unknown`
Used to update the settings of an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -389,7 +389,7 @@ Used to update the settings of an index
}
]} />
#### Returns
##### Returns
`unknown`

View File

@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### create
#### create
`**create**(input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to create a stock location.
#### Example
##### Example
```ts
import {
@@ -32,7 +32,7 @@ async function createStockLocation (name: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -55,7 +55,7 @@ async function createStockLocation (name: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
@@ -73,13 +73,13 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
___
### delete
#### delete
`**delete**(id, context?): Promise&#60;void&#62;`
This method is used to delete a stock location.
#### Example
##### Example
```ts
import {
@@ -93,7 +93,7 @@ async function deleteStockLocation (id:string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -116,7 +116,7 @@ async function deleteStockLocation (id:string) {
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -134,13 +134,13 @@ Promise&#60;void&#62;
___
### list
#### list
`**list**(selector, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;`
This method is used to retrieve a paginated list of stock locations based on optional filters and configuration.
#### Example
##### Example
To retrieve a list of stock locations using their IDs:
@@ -202,7 +202,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -234,7 +234,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
@@ -252,13 +252,13 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?, context?): Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;`
This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
#### Example
##### Example
To retrieve a list of stock locations using their IDs:
@@ -320,7 +320,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -352,7 +352,7 @@ async function listStockLocations (ids: string[], skip: number, take: number) {
}
]} />
#### Returns
##### Returns
Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
@@ -370,13 +370,13 @@ Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;
___
### retrieve
#### retrieve
`**retrieve**(id, config?, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to retrieve a stock location by its ID
#### Example
##### Example
A simple example that retrieves a inventory item by its ID:
@@ -412,7 +412,7 @@ async function retrieveStockLocation (id: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -444,7 +444,7 @@ async function retrieveStockLocation (id: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
@@ -462,13 +462,13 @@ Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;
___
### update
#### update
`**update**(id, input, context?): Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;`
This method is used to update a stock location.
#### Example
##### Example
```ts
import {
@@ -486,7 +486,7 @@ async function updateStockLocation (id:string, name: string) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -518,7 +518,7 @@ async function updateStockLocation (id:string, name: string) {
}
]} />
#### Returns
##### Returns
Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;

View File

@@ -8,14 +8,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### calculate
#### calculate
`**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.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ tax conditions and calculation contexts.
}
]} />
#### Returns
##### Returns
Promise&#60;number&#62;

View File

@@ -12,13 +12,13 @@ items and shipping methods.
## Methods
### getTaxLines
#### getTaxLines
`**getTaxLines**(itemLines, shippingLines, context): Promise&#60;[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]&#62;`
Retrieves the numerical tax lines for a calculation context.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -50,7 +50,7 @@ Retrieves the numerical tax lines for a calculation context.
}
]} />
#### Returns
##### Returns
Promise&#60;[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]&#62;

View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [ITransactionBaseService](ITransactionBaseService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -26,7 +26,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
[ITransactionBaseService](ITransactionBaseService.mdx)

View File

@@ -22,11 +22,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### [iterator]
#### [iterator]
`**[iterator]**(): [IterableIterator](IterableIterator.mdx)&#60;T&#62;`
#### Returns
##### Returns
[IterableIterator](IterableIterator.mdx)&#60;T&#62;
@@ -44,11 +44,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
### next
#### next
`**next**(...args): [IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -62,7 +62,7 @@ ___
}
]} />
#### Returns
##### Returns
[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;
@@ -80,11 +80,11 @@ ___
___
### return
#### return
`Optional **return**(value?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -98,7 +98,7 @@ ___
}
]} />
#### Returns
##### Returns
[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;
@@ -116,11 +116,11 @@ ___
___
### throw
#### throw
`Optional **throw**(e?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -134,7 +134,7 @@ ___
}
]} />
#### Returns
##### Returns
[IteratorResult](../types/IteratorResult.mdx)&#60;T, any&#62;

View File

@@ -40,11 +40,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### next
#### next
`**next**(...args): [IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;
@@ -76,11 +76,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
### return
#### return
`Optional **return**(value?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -94,7 +94,7 @@ ___
}
]} />
#### Returns
##### Returns
[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;
@@ -112,11 +112,11 @@ ___
___
### throw
#### throw
`Optional **throw**(e?): [IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -130,7 +130,7 @@ ___
}
]} />
#### Returns
##### Returns
[IteratorResult](../types/IteratorResult.mdx)&#60;T, TReturn&#62;

View File

@@ -71,7 +71,7 @@ A money amount's data. A money amount represents a price.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]} />

View File

@@ -11,13 +11,13 @@ This work is still experimental and can be changed until it becomes stable
## Methods
### authorizePayment
#### authorizePayment
`**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
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -40,7 +40,7 @@ Authorize an existing session if it is not already authorized
}
]} />
#### Returns
##### Returns
Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| &#123; data: Record&#60;string, unknown&#62; ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) &#125;&#62;
@@ -58,13 +58,13 @@ Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| &#123; data: R
___
### cancelPayment
#### cancelPayment
`**cancelPayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Cancel an existing session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -78,7 +78,7 @@ Cancel an existing session
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
@@ -96,13 +96,13 @@ Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentPr
___
### capturePayment
#### capturePayment
`**capturePayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Capture an existing session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -116,7 +116,7 @@ Capture an existing session
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
@@ -134,13 +134,13 @@ Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentPr
___
### deletePayment
#### deletePayment
`**deletePayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Delete an existing session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -154,7 +154,7 @@ Delete an existing session
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
@@ -172,13 +172,13 @@ Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentPr
___
### getIdentifier
#### getIdentifier
`**getIdentifier**(): string`
Return a unique identifier to retrieve the payment plugin provider
#### Returns
##### Returns
`string`
@@ -196,13 +196,13 @@ Return a unique identifier to retrieve the payment plugin provider
___
### getPaymentStatus
#### getPaymentStatus
`**getPaymentStatus**(paymentSessionData): Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;`
Return the status of the session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -216,7 +216,7 @@ Return the status of the session
}
]} />
#### Returns
##### Returns
Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;
@@ -234,13 +234,13 @@ Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;
___
### initiatePayment
#### initiatePayment
`**initiatePayment**(context): Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;`
Initiate a payment session with the external provider
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -254,7 +254,7 @@ Initiate a payment session with the external provider
}
]} />
#### Returns
##### Returns
Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;
@@ -272,13 +272,13 @@ Promise&#60;[PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProces
___
### refundPayment
#### refundPayment
`**refundPayment**(paymentSessionData, refundAmount): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Refund an existing session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -301,7 +301,7 @@ Refund an existing session
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
@@ -319,13 +319,13 @@ Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentPr
___
### retrievePayment
#### retrievePayment
`**retrievePayment**(paymentSessionData): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Retrieve an existing session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -339,7 +339,7 @@ Retrieve an existing session
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;
@@ -357,13 +357,13 @@ Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentPr
___
### updatePayment
#### updatePayment
`**updatePayment**(context): Promise&#60;void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;`
Update an existing payment session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -377,7 +377,7 @@ Update an existing payment session
}
]} />
#### Returns
##### Returns
Promise&#60;void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [PaymentProcessorSessionResponse](../types/PaymentProcessorSessionResponse.mdx)&#62;
@@ -395,13 +395,13 @@ Promise&#60;void \| [PaymentProcessorError](PaymentProcessorError.mdx) \| [Payme
___
### updatePaymentData
#### updatePaymentData
`**updatePaymentData**(sessionId, data): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;`
Update the session data for a payment session
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -424,7 +424,7 @@ Update the session data for a payment session
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentProcessorError](PaymentProcessorError.mdx)&#62;

View File

@@ -40,13 +40,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### slice
#### slice
`**slice**(begin, end?): [SharedArrayBuffer](../index.md#sharedarraybuffer)`
Returns a section of an SharedArrayBuffer.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -69,7 +69,7 @@ Returns a section of an SharedArrayBuffer.
}
]} />
#### Returns
##### Returns
[SharedArrayBuffer](../index.md#sharedarraybuffer)

View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new SharedArrayBufferConstructor**(byteLength)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{

View File

@@ -13,7 +13,7 @@ The attributes to update in a price list.
<ParameterTypes parameters={[
{
"name": "ends_at",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The price list expires after this date.",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ The attributes to update in a price list.
},
{
"name": "starts_at",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The price list is enabled starting from this date.",
"optional": true,
"defaultValue": "",