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:
co-authored by
Oli Juhl
Shahed Nasser
parent
dc6b815b12
commit
cdd42dbdcd
@@ -231,7 +231,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [Buffer](interfaces/Buffer.mdx)
|
||||
- [BufferConstructor](interfaces/BufferConstructor.mdx)
|
||||
- [BulkUpdateInventoryLevelInput](interfaces/BulkUpdateInventoryLevelInput.mdx)
|
||||
- [CalculatedPriceSetDTO](interfaces/CalculatedPriceSetDTO.mdx)
|
||||
- [CalculatedPriceSet](interfaces/CalculatedPriceSet.mdx)
|
||||
- [Context](interfaces/Context.mdx)
|
||||
- [CreateCurrencyDTO](interfaces/CreateCurrencyDTO.mdx)
|
||||
- [CreateInventoryItemInput](interfaces/CreateInventoryItemInput.mdx)
|
||||
@@ -606,25 +606,25 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### DEFAULT
|
||||
#### DEFAULT
|
||||
|
||||
**DEFAULT**: `"default"`
|
||||
|
||||
___
|
||||
|
||||
### EXTERNAL
|
||||
#### EXTERNAL
|
||||
|
||||
**EXTERNAL**: `"external"`
|
||||
|
||||
___
|
||||
|
||||
### INTERNAL
|
||||
#### INTERNAL
|
||||
|
||||
**INTERNAL**: `"internal"`
|
||||
|
||||
___
|
||||
|
||||
### ORDER\_EDIT
|
||||
#### ORDER\_EDIT
|
||||
|
||||
**ORDER\_EDIT**: `"order_edit"`
|
||||
|
||||
@@ -632,221 +632,221 @@ The payment collection is used for an order edit.
|
||||
|
||||
## Variables
|
||||
|
||||
### AddressRepository
|
||||
#### AddressRepository
|
||||
|
||||
`Const` **AddressRepository**: Repository<[Address](classes/Address.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### AnalyticsConfigRepository
|
||||
#### AnalyticsConfigRepository
|
||||
|
||||
`Const` **AnalyticsConfigRepository**: Repository<[AnalyticsConfig](classes/AnalyticsConfig.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### BatchJobRepository
|
||||
#### BatchJobRepository
|
||||
|
||||
`Const` **BatchJobRepository**: Repository<[BatchJob](classes/BatchJob.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### Buffer
|
||||
#### Buffer
|
||||
|
||||
**Buffer**: [BufferConstructor](interfaces/BufferConstructor.mdx)
|
||||
|
||||
___
|
||||
|
||||
### CartRepository
|
||||
#### CartRepository
|
||||
|
||||
`Const` **CartRepository**: Repository<[Cart](classes/Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``
|
||||
|
||||
___
|
||||
|
||||
### ClaimRepository
|
||||
#### ClaimRepository
|
||||
|
||||
`Const` **ClaimRepository**: Repository<[ClaimOrder](classes/ClaimOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### CountryRepository
|
||||
#### CountryRepository
|
||||
|
||||
`Const` **CountryRepository**: Repository<[Country](classes/Country.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### CurrencyRepository
|
||||
#### CurrencyRepository
|
||||
|
||||
`Const` **CurrencyRepository**: Repository<[Currency](classes/Currency.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### CustomShippingOptionRepository
|
||||
#### CustomShippingOptionRepository
|
||||
|
||||
`Const` **CustomShippingOptionRepository**: Repository<[CustomShippingOption](classes/CustomShippingOption.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### CustomerGroupRepository
|
||||
#### CustomerGroupRepository
|
||||
|
||||
`Const` **CustomerGroupRepository**: Repository<[CustomerGroup](classes/CustomerGroup.mdx)> & ``{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }``
|
||||
|
||||
___
|
||||
|
||||
### CustomerRepository
|
||||
#### CustomerRepository
|
||||
|
||||
`Const` **CustomerRepository**: Repository<[Customer](classes/Customer.mdx)> & ``{ listAndCount: Method listAndCount }``
|
||||
|
||||
___
|
||||
|
||||
### DiscountConditionRepository
|
||||
#### DiscountConditionRepository
|
||||
|
||||
`Const` **DiscountConditionRepository**: Repository<[DiscountCondition](classes/DiscountCondition.mdx)> & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }``
|
||||
|
||||
___
|
||||
|
||||
### DraftOrderRepository
|
||||
#### DraftOrderRepository
|
||||
|
||||
`Const` **DraftOrderRepository**: Repository<[DraftOrder](classes/DraftOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### FulfillmentProviderRepository
|
||||
#### FulfillmentProviderRepository
|
||||
|
||||
`Const` **FulfillmentProviderRepository**: Repository<[FulfillmentProvider](classes/FulfillmentProvider.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### FulfillmentRepository
|
||||
#### FulfillmentRepository
|
||||
|
||||
`Const` **FulfillmentRepository**: Repository<[Fulfillment](classes/Fulfillment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### GiftCardRepository
|
||||
#### GiftCardRepository
|
||||
|
||||
`Const` **GiftCardRepository**: Repository<[GiftCard](classes/GiftCard.mdx)> & ``{ listGiftCardsAndCount: Method listGiftCardsAndCount }``
|
||||
|
||||
___
|
||||
|
||||
### GiftCardTransactionRepository
|
||||
#### GiftCardTransactionRepository
|
||||
|
||||
`Const` **GiftCardTransactionRepository**: Repository<[GiftCardTransaction](classes/GiftCardTransaction.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### IdempotencyKeyRepository
|
||||
#### IdempotencyKeyRepository
|
||||
|
||||
`Const` **IdempotencyKeyRepository**: Repository<[IdempotencyKey](classes/IdempotencyKey.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ImageRepository
|
||||
#### ImageRepository
|
||||
|
||||
`Const` **ImageRepository**: Repository<[Image](classes/Image.mdx)> & ``{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }``
|
||||
|
||||
___
|
||||
|
||||
### LineItemAdjustmentRepository
|
||||
#### LineItemAdjustmentRepository
|
||||
|
||||
`Const` **LineItemAdjustmentRepository**: Repository<[LineItemAdjustment](classes/LineItemAdjustment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### LineItemRepository
|
||||
#### LineItemRepository
|
||||
|
||||
`Const` **LineItemRepository**: Repository<[LineItem](classes/LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``
|
||||
|
||||
___
|
||||
|
||||
### LineItemTaxLineRepository
|
||||
#### LineItemTaxLineRepository
|
||||
|
||||
`Const` **LineItemTaxLineRepository**: Repository<[LineItemTaxLine](classes/LineItemTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }``
|
||||
|
||||
___
|
||||
|
||||
### MoneyAmountRepository
|
||||
#### MoneyAmountRepository
|
||||
|
||||
`Const` **MoneyAmountRepository**: Repository<[MoneyAmount](classes/MoneyAmount.mdx)> & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }``
|
||||
|
||||
___
|
||||
|
||||
### NoteRepository
|
||||
#### NoteRepository
|
||||
|
||||
`Const` **NoteRepository**: Repository<[Note](classes/Note.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### NotificationProviderRepository
|
||||
#### NotificationProviderRepository
|
||||
|
||||
`Const` **NotificationProviderRepository**: Repository<[NotificationProvider](classes/NotificationProvider.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### NotificationRepository
|
||||
#### NotificationRepository
|
||||
|
||||
`Const` **NotificationRepository**: Repository<[Notification](classes/Notification.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### OauthRepository
|
||||
#### OauthRepository
|
||||
|
||||
`Const` **OauthRepository**: Repository<[Oauth](classes/Oauth.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### OrderEditRepository
|
||||
#### OrderEditRepository
|
||||
|
||||
`Const` **OrderEditRepository**: Repository<[OrderEdit](classes/OrderEdit.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### OrderItemChangeRepository
|
||||
#### OrderItemChangeRepository
|
||||
|
||||
`Const` **OrderItemChangeRepository**: Repository<[OrderItemChange](classes/OrderItemChange.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### OrderRepository
|
||||
#### OrderRepository
|
||||
|
||||
`Const` **OrderRepository**: Repository<[Order](classes/Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``
|
||||
|
||||
___
|
||||
|
||||
### PaymentCollectionRepository
|
||||
#### PaymentCollectionRepository
|
||||
|
||||
`Const` **PaymentCollectionRepository**: Repository<[PaymentCollection](classes/PaymentCollection.mdx)> & ``{ getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }``
|
||||
|
||||
___
|
||||
|
||||
### PaymentProviderRepository
|
||||
#### PaymentProviderRepository
|
||||
|
||||
`Const` **PaymentProviderRepository**: Repository<[PaymentProvider](classes/PaymentProvider.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### PaymentRepository
|
||||
#### PaymentRepository
|
||||
|
||||
`Const` **PaymentRepository**: Repository<[Payment](classes/Payment.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### PaymentSessionRepository
|
||||
#### PaymentSessionRepository
|
||||
|
||||
`Const` **PaymentSessionRepository**: Repository<[PaymentSession](classes/PaymentSession.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### PriceListRepository
|
||||
#### PriceListRepository
|
||||
|
||||
`Const` **PriceListRepository**: Repository<[PriceList](classes/PriceList.mdx)> & ``{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }``
|
||||
|
||||
___
|
||||
|
||||
### PriceType
|
||||
#### PriceType
|
||||
|
||||
**PriceType**: `Object`
|
||||
|
||||
### Type declaration
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -880,154 +880,156 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### ProductCategoryRepository
|
||||
#### ProductCategoryRepository
|
||||
|
||||
`Const` **ProductCategoryRepository**: TreeRepository<[ProductCategory](classes/ProductCategory.mdx)> & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``
|
||||
|
||||
___
|
||||
|
||||
### ProductCollectionRepository
|
||||
#### ProductCollectionRepository
|
||||
|
||||
`Const` **ProductCollectionRepository**: Repository<[ProductCollection](classes/ProductCollection.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }``
|
||||
|
||||
___
|
||||
|
||||
### ProductOptionRepository
|
||||
#### ProductOptionRepository
|
||||
|
||||
`Const` **ProductOptionRepository**: Repository<[ProductOption](classes/ProductOption.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ProductRepository
|
||||
#### ProductRepository
|
||||
|
||||
`Const` **ProductRepository**: Repository<[Product](classes/Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``
|
||||
|
||||
___
|
||||
|
||||
### ProductTagRepository
|
||||
#### ProductTagRepository
|
||||
|
||||
`Const` **ProductTagRepository**: Repository<[ProductTag](classes/ProductTag.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }``
|
||||
|
||||
___
|
||||
|
||||
### ProductTypeRepository
|
||||
#### ProductTypeRepository
|
||||
|
||||
`Const` **ProductTypeRepository**: Repository<[ProductType](classes/ProductType.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``
|
||||
|
||||
___
|
||||
|
||||
### ProductVariantRepository
|
||||
#### ProductVariantRepository
|
||||
|
||||
`Const` **ProductVariantRepository**: Repository<[ProductVariant](classes/ProductVariant.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### RefundRepository
|
||||
#### RefundRepository
|
||||
|
||||
`Const` **RefundRepository**: Repository<[Refund](classes/Refund.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### RegionRepository
|
||||
#### RegionRepository
|
||||
|
||||
`Const` **RegionRepository**: Repository<[Region](classes/Region.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ReturnItemRepository
|
||||
#### ReturnItemRepository
|
||||
|
||||
`Const` **ReturnItemRepository**: Repository<[ReturnItem](classes/ReturnItem.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ReturnReasonRepository
|
||||
#### ReturnReasonRepository
|
||||
|
||||
`Const` **ReturnReasonRepository**: Repository<[ReturnReason](classes/ReturnReason.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ReturnRepository
|
||||
#### ReturnRepository
|
||||
|
||||
`Const` **ReturnRepository**: Repository<[Return](classes/Return.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### SalesChannelRepository
|
||||
#### SalesChannelRepository
|
||||
|
||||
`Const` **SalesChannelRepository**: Repository<[SalesChannel](classes/SalesChannel.mdx)> & ``{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }``
|
||||
|
||||
___
|
||||
|
||||
### SharedArrayBuffer
|
||||
#### SharedArrayBuffer
|
||||
|
||||
**SharedArrayBuffer**: [SharedArrayBufferConstructor](interfaces/SharedArrayBufferConstructor.mdx)
|
||||
|
||||
___
|
||||
|
||||
### ShippingMethodRepository
|
||||
#### ShippingMethodRepository
|
||||
|
||||
`Const` **ShippingMethodRepository**: Repository<[ShippingMethod](classes/ShippingMethod.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ShippingOptionRepository
|
||||
#### ShippingOptionRepository
|
||||
|
||||
`Const` **ShippingOptionRepository**: Repository<[ShippingOption](classes/ShippingOption.mdx)> & ``{ upsertShippingProfile: Method upsertShippingProfile }``
|
||||
|
||||
___
|
||||
|
||||
### ShippingOptionRequirementRepository
|
||||
#### ShippingOptionRequirementRepository
|
||||
|
||||
`Const` **ShippingOptionRequirementRepository**: Repository<[ShippingOptionRequirement](classes/ShippingOptionRequirement.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### ShippingProfileRepository
|
||||
#### ShippingProfileRepository
|
||||
|
||||
`Const` **ShippingProfileRepository**: Repository<[ShippingProfile](classes/ShippingProfile.mdx)> & ``{ findByProducts: Method findByProducts }``
|
||||
|
||||
___
|
||||
|
||||
### StagedJobRepository
|
||||
#### StagedJobRepository
|
||||
|
||||
`Const` **StagedJobRepository**: Repository<[StagedJob](classes/StagedJob.mdx)> & ``{ insertBulk: Method insertBulk }``
|
||||
|
||||
___
|
||||
|
||||
### StoreRepository
|
||||
#### StoreRepository
|
||||
|
||||
`Const` **StoreRepository**: Repository<[Store](classes/Store.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### SwapRepository
|
||||
#### SwapRepository
|
||||
|
||||
`Const` **SwapRepository**: Repository<[Swap](classes/Swap.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### TaxProviderRepository
|
||||
#### TaxProviderRepository
|
||||
|
||||
`Const` **TaxProviderRepository**: Repository<[TaxProvider](classes/TaxProvider.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### TrackingLinkRepository
|
||||
#### TrackingLinkRepository
|
||||
|
||||
`Const` **TrackingLinkRepository**: Repository<[TrackingLink](classes/TrackingLink.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### UserRepository
|
||||
#### UserRepository
|
||||
|
||||
`Const` **UserRepository**: Repository<[User](classes/User.mdx)>
|
||||
|
||||
## Functions
|
||||
|
||||
### Boolean
|
||||
#### Boolean
|
||||
|
||||
`**Boolean**<TypeParameter T>(value?): boolean`
|
||||
|
||||
##### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
@@ -1040,7 +1042,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1054,7 +1056,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user