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:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -451,6 +451,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [HeadersDefaults](../internal/interfaces/internal.HeadersDefaults.mdx)
|
||||
- [ITransactionBaseService](../internal/interfaces/internal.ITransactionBaseService.mdx)
|
||||
- [IncomingHttpHeaders](../internal/interfaces/internal.IncomingHttpHeaders.mdx)
|
||||
- [InputPrice](../internal/interfaces/internal.InputPrice.mdx)
|
||||
- [IpcSocketConnectOpts](../internal/interfaces/internal.IpcSocketConnectOpts.mdx)
|
||||
- [Iterable](../internal/interfaces/internal.Iterable.mdx)
|
||||
- [IterableIterator](../internal/interfaces/internal.IterableIterator.mdx)
|
||||
@@ -957,99 +958,99 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### DEFAULT
|
||||
#### DEFAULT
|
||||
|
||||
___
|
||||
|
||||
### ORDER\_EDIT
|
||||
#### ORDER\_EDIT
|
||||
|
||||
The payment collection is used for an order edit.
|
||||
|
||||
## Variables
|
||||
|
||||
### AddressRepository
|
||||
#### AddressRepository
|
||||
|
||||
___
|
||||
|
||||
### AdminGetDiscountsParams\_base
|
||||
#### AdminGetDiscountsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AdminGetInventoryItemsParams\_base
|
||||
#### AdminGetInventoryItemsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AdminGetPriceListsPriceListProductsParams\_base
|
||||
#### AdminGetPriceListsPriceListProductsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AdminGetProductCategoriesParams\_base
|
||||
#### AdminGetProductCategoriesParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AdminGetReservationsParams\_base
|
||||
#### AdminGetReservationsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AdminGetSalesChannelsParams\_base
|
||||
#### AdminGetSalesChannelsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AdminGetStockLocationsParams\_base
|
||||
#### AdminGetStockLocationsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### AnalyticsConfigRepository
|
||||
#### AnalyticsConfigRepository
|
||||
|
||||
___
|
||||
|
||||
### BatchJobRepository
|
||||
#### BatchJobRepository
|
||||
|
||||
___
|
||||
|
||||
### Buffer
|
||||
#### Buffer
|
||||
|
||||
___
|
||||
|
||||
### CartRepository
|
||||
#### CartRepository
|
||||
|
||||
___
|
||||
|
||||
### ClaimRepository
|
||||
#### ClaimRepository
|
||||
|
||||
___
|
||||
|
||||
### CountryRepository
|
||||
#### CountryRepository
|
||||
|
||||
___
|
||||
|
||||
### CurrencyRepository
|
||||
#### CurrencyRepository
|
||||
|
||||
___
|
||||
|
||||
### CustomShippingOptionRepository
|
||||
#### CustomShippingOptionRepository
|
||||
|
||||
___
|
||||
|
||||
### CustomerGroupRepository
|
||||
#### CustomerGroupRepository
|
||||
|
||||
___
|
||||
|
||||
### CustomerRepository
|
||||
#### CustomerRepository
|
||||
|
||||
___
|
||||
|
||||
### DiscountConditionRepository
|
||||
#### DiscountConditionRepository
|
||||
|
||||
___
|
||||
|
||||
### DraftOrderRepository
|
||||
#### DraftOrderRepository
|
||||
|
||||
___
|
||||
|
||||
### File
|
||||
#### File
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -1097,7 +1098,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1113,143 +1114,143 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### FulfillmentProviderRepository
|
||||
#### FulfillmentProviderRepository
|
||||
|
||||
___
|
||||
|
||||
### FulfillmentRepository
|
||||
#### FulfillmentRepository
|
||||
|
||||
___
|
||||
|
||||
### GetOrderEditsParams\_base
|
||||
#### GetOrderEditsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### GetPublishableApiKeySalesChannelsParams\_base
|
||||
#### GetPublishableApiKeySalesChannelsParams\_base
|
||||
|
||||
___
|
||||
|
||||
### GetPublishableApiKeysParams\_base
|
||||
#### GetPublishableApiKeysParams\_base
|
||||
|
||||
___
|
||||
|
||||
### GiftCardRepository
|
||||
#### GiftCardRepository
|
||||
|
||||
___
|
||||
|
||||
### GiftCardTransactionRepository
|
||||
#### GiftCardTransactionRepository
|
||||
|
||||
___
|
||||
|
||||
### HTTP\_METHODS
|
||||
#### HTTP\_METHODS
|
||||
|
||||
List of all the supported HTTP methods
|
||||
|
||||
___
|
||||
|
||||
### IdempotencyKeyRepository
|
||||
#### IdempotencyKeyRepository
|
||||
|
||||
___
|
||||
|
||||
### ImageRepository
|
||||
#### ImageRepository
|
||||
|
||||
___
|
||||
|
||||
### LineItemAdjustmentRepository
|
||||
#### LineItemAdjustmentRepository
|
||||
|
||||
___
|
||||
|
||||
### LineItemRepository
|
||||
#### LineItemRepository
|
||||
|
||||
___
|
||||
|
||||
### LineItemTaxLineRepository
|
||||
#### LineItemTaxLineRepository
|
||||
|
||||
___
|
||||
|
||||
### MoneyAmountRepository
|
||||
#### MoneyAmountRepository
|
||||
|
||||
___
|
||||
|
||||
### NoteRepository
|
||||
#### NoteRepository
|
||||
|
||||
___
|
||||
|
||||
### NotificationProviderRepository
|
||||
#### NotificationProviderRepository
|
||||
|
||||
___
|
||||
|
||||
### NotificationRepository
|
||||
#### NotificationRepository
|
||||
|
||||
___
|
||||
|
||||
### OauthRepository
|
||||
#### OauthRepository
|
||||
|
||||
___
|
||||
|
||||
### OrderEditRepository
|
||||
#### OrderEditRepository
|
||||
|
||||
___
|
||||
|
||||
### OrderItemChangeRepository
|
||||
#### OrderItemChangeRepository
|
||||
|
||||
___
|
||||
|
||||
### OrderRepository
|
||||
#### OrderRepository
|
||||
|
||||
___
|
||||
|
||||
### PaymentCollectionRepository
|
||||
#### PaymentCollectionRepository
|
||||
|
||||
___
|
||||
|
||||
### PaymentProviderRepository
|
||||
#### PaymentProviderRepository
|
||||
|
||||
___
|
||||
|
||||
### PaymentRepository
|
||||
#### PaymentRepository
|
||||
|
||||
___
|
||||
|
||||
### PaymentSessionRepository
|
||||
#### PaymentSessionRepository
|
||||
|
||||
___
|
||||
|
||||
### PriceListRepository
|
||||
#### PriceListRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductCategoryRepository
|
||||
#### ProductCategoryRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductCollectionRepository
|
||||
#### ProductCollectionRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductOptionRepository
|
||||
#### ProductOptionRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductRepository
|
||||
#### ProductRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductTagRepository
|
||||
#### ProductTagRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductTypeRepository
|
||||
#### ProductTypeRepository
|
||||
|
||||
___
|
||||
|
||||
### ProductVariantRepository
|
||||
#### ProductVariantRepository
|
||||
|
||||
___
|
||||
|
||||
### ReadableByteStreamController
|
||||
#### ReadableByteStreamController
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -1265,7 +1266,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1281,9 +1282,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableByteStreamController
|
||||
#### ReadableByteStreamController
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -1299,7 +1300,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1315,9 +1316,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStream
|
||||
#### ReadableStream
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
`**new ReadableStream**(underlyingSource, strategy?): [ReadableStream](internal.mdx#readablestream)<Uint8Array>`
|
||||
|
||||
@@ -1445,7 +1446,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1461,9 +1462,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStream
|
||||
#### ReadableStream
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
`**new ReadableStream**(underlyingSource, strategy?): [ReadableStream](internal.mdx#readablestream-1)<Uint8Array>`
|
||||
|
||||
@@ -1543,7 +1544,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1559,9 +1560,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamBYOBReader
|
||||
#### ReadableStreamBYOBReader
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -1591,7 +1592,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1607,13 +1608,13 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamBYOBReader
|
||||
#### ReadableStreamBYOBReader
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamBYOBRequest
|
||||
#### ReadableStreamBYOBRequest
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -1629,7 +1630,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1645,9 +1646,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamDefaultController
|
||||
#### ReadableStreamDefaultController
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -1663,7 +1664,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1679,9 +1680,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamDefaultController
|
||||
#### ReadableStreamDefaultController
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -1697,7 +1698,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1713,9 +1714,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamDefaultReader
|
||||
#### ReadableStreamDefaultReader
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -1745,7 +1746,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1761,9 +1762,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamDefaultReader
|
||||
#### ReadableStreamDefaultReader
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -1793,7 +1794,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1809,81 +1810,81 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### RefundRepository
|
||||
#### RefundRepository
|
||||
|
||||
___
|
||||
|
||||
### RegionRepository
|
||||
#### RegionRepository
|
||||
|
||||
___
|
||||
|
||||
### ReturnItemRepository
|
||||
#### ReturnItemRepository
|
||||
|
||||
___
|
||||
|
||||
### ReturnReasonRepository
|
||||
#### ReturnReasonRepository
|
||||
|
||||
___
|
||||
|
||||
### ReturnRepository
|
||||
#### ReturnRepository
|
||||
|
||||
___
|
||||
|
||||
### SalesChannelRepository
|
||||
#### SalesChannelRepository
|
||||
|
||||
___
|
||||
|
||||
### SharedArrayBuffer
|
||||
#### SharedArrayBuffer
|
||||
|
||||
___
|
||||
|
||||
### ShippingMethodRepository
|
||||
#### ShippingMethodRepository
|
||||
|
||||
___
|
||||
|
||||
### ShippingOptionRepository
|
||||
#### ShippingOptionRepository
|
||||
|
||||
___
|
||||
|
||||
### ShippingOptionRequirementRepository
|
||||
#### ShippingOptionRequirementRepository
|
||||
|
||||
___
|
||||
|
||||
### ShippingProfileRepository
|
||||
#### ShippingProfileRepository
|
||||
|
||||
___
|
||||
|
||||
### StagedJobRepository
|
||||
#### StagedJobRepository
|
||||
|
||||
___
|
||||
|
||||
### StoreGetProductCategoriesParams\_base
|
||||
#### StoreGetProductCategoriesParams\_base
|
||||
|
||||
___
|
||||
|
||||
### StoreRepository
|
||||
#### StoreRepository
|
||||
|
||||
___
|
||||
|
||||
### SwapRepository
|
||||
#### SwapRepository
|
||||
|
||||
___
|
||||
|
||||
### TaxProviderRepository
|
||||
#### TaxProviderRepository
|
||||
|
||||
___
|
||||
|
||||
### TrackingLinkRepository
|
||||
#### TrackingLinkRepository
|
||||
|
||||
___
|
||||
|
||||
### UserRepository
|
||||
#### UserRepository
|
||||
|
||||
___
|
||||
|
||||
### WritableStream
|
||||
#### WritableStream
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -1922,7 +1923,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1938,9 +1939,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### WritableStream
|
||||
#### WritableStream
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -1979,7 +1980,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1995,9 +1996,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### WritableStreamDefaultController
|
||||
#### WritableStreamDefaultController
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -2013,7 +2014,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2029,9 +2030,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### WritableStreamDefaultController
|
||||
#### WritableStreamDefaultController
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -2047,7 +2048,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2063,9 +2064,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### WritableStreamDefaultWriter
|
||||
#### WritableStreamDefaultWriter
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -2095,7 +2096,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2111,9 +2112,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### WritableStreamDefaultWriter
|
||||
#### WritableStreamDefaultWriter
|
||||
|
||||
### Call signature
|
||||
#### Call signature
|
||||
|
||||
##### Parameters
|
||||
|
||||
@@ -2143,7 +2144,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2159,9 +2160,9 @@ ___
|
||||
|
||||
## Functions
|
||||
|
||||
### Boolean
|
||||
#### Boolean
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2175,7 +2176,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2191,9 +2192,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### Error
|
||||
#### Error
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2207,7 +2208,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user