c6dff873de
* update dependencies * update onboarding mdx * fixes for mdx issues * fixes for mdx compatibility * resolve mdx errors * fixes in reference * fix check errors * revert change in vale action * fix node version in action * fix summary in markdown
185 lines
6.2 KiB
Plaintext
185 lines
6.2 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# Entities Reference
|
|
|
|
## Enumerations
|
|
|
|
- [AllocationType](enums/AllocationType.mdx)
|
|
- [BatchJobStatus](enums/BatchJobStatus.mdx)
|
|
- [CartType](enums/CartType.mdx)
|
|
- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.mdx)
|
|
- [ClaimPaymentStatus](enums/ClaimPaymentStatus.mdx)
|
|
- [ClaimReason](enums/ClaimReason.mdx)
|
|
- [ClaimType](enums/ClaimType.mdx)
|
|
- [DiscountConditionOperator](enums/DiscountConditionOperator.mdx)
|
|
- [DiscountConditionType](enums/DiscountConditionType.mdx)
|
|
- [DiscountRuleType](enums/DiscountRuleType.mdx)
|
|
- [DraftOrderStatus](enums/DraftOrderStatus.mdx)
|
|
- [FulfillmentStatus](enums/FulfillmentStatus.mdx)
|
|
- [OrderEditItemChangeType](enums/OrderEditItemChangeType.mdx)
|
|
- [OrderEditStatus](enums/OrderEditStatus.mdx)
|
|
- [OrderStatus](enums/OrderStatus.mdx)
|
|
- [PaymentCollectionStatus](enums/PaymentCollectionStatus.mdx)
|
|
- [PaymentCollectionType](enums/PaymentCollectionType.mdx)
|
|
- [PaymentSessionStatus](enums/PaymentSessionStatus.mdx)
|
|
- [PaymentStatus](enums/PaymentStatus.mdx)
|
|
- [PriceListStatus](enums/PriceListStatus.mdx)
|
|
- [PriceListType](enums/PriceListType.mdx)
|
|
- [ProductStatus](enums/ProductStatus.mdx)
|
|
- [RefundReason](enums/RefundReason.mdx)
|
|
- [RequirementType](enums/RequirementType.mdx)
|
|
- [ReturnStatus](enums/ReturnStatus.mdx)
|
|
- [ShippingOptionPriceType](enums/ShippingOptionPriceType.mdx)
|
|
- [ShippingProfileType](enums/ShippingProfileType.mdx)
|
|
- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.mdx)
|
|
- [SwapPaymentStatus](enums/SwapPaymentStatus.mdx)
|
|
- [UserRoles](enums/UserRoles.mdx)
|
|
|
|
## Classes
|
|
|
|
- [Address](classes/Address.mdx)
|
|
- [AnalyticsConfig](classes/AnalyticsConfig.mdx)
|
|
- [BaseEntity](classes/BaseEntity.mdx)
|
|
- [BatchJob](classes/BatchJob.mdx)
|
|
- [Cart](classes/Cart.mdx)
|
|
- [ClaimImage](classes/ClaimImage.mdx)
|
|
- [ClaimItem](classes/ClaimItem.mdx)
|
|
- [ClaimOrder](classes/ClaimOrder.mdx)
|
|
- [ClaimTag](classes/ClaimTag.mdx)
|
|
- [Country](classes/Country.mdx)
|
|
- [Currency](classes/Currency.mdx)
|
|
- [CustomShippingOption](classes/CustomShippingOption.mdx)
|
|
- [Customer](classes/Customer.mdx)
|
|
- [CustomerGroup](classes/CustomerGroup.mdx)
|
|
- [Discount](classes/Discount.mdx)
|
|
- [DiscountCondition](classes/DiscountCondition.mdx)
|
|
- [DiscountConditionCustomerGroup](classes/DiscountConditionCustomerGroup.mdx)
|
|
- [DiscountConditionProduct](classes/DiscountConditionProduct.mdx)
|
|
- [DiscountConditionProductCollection](classes/DiscountConditionProductCollection.mdx)
|
|
- [DiscountConditionProductTag](classes/DiscountConditionProductTag.mdx)
|
|
- [DiscountConditionProductType](classes/DiscountConditionProductType.mdx)
|
|
- [DiscountRule](classes/DiscountRule.mdx)
|
|
- [DraftOrder](classes/DraftOrder.mdx)
|
|
- [Fulfillment](classes/Fulfillment.mdx)
|
|
- [FulfillmentItem](classes/FulfillmentItem.mdx)
|
|
- [FulfillmentProvider](classes/FulfillmentProvider.mdx)
|
|
- [GiftCard](classes/GiftCard.mdx)
|
|
- [GiftCardTransaction](classes/GiftCardTransaction.mdx)
|
|
- [IdempotencyKey](classes/IdempotencyKey.mdx)
|
|
- [Image](classes/Image.mdx)
|
|
- [Invite](classes/Invite.mdx)
|
|
- [LineItem](classes/LineItem.mdx)
|
|
- [LineItemAdjustment](classes/LineItemAdjustment.mdx)
|
|
- [LineItemTaxLine](classes/LineItemTaxLine.mdx)
|
|
- [MoneyAmount](classes/MoneyAmount.mdx)
|
|
- [Note](classes/Note.mdx)
|
|
- [Notification](classes/Notification.mdx)
|
|
- [NotificationProvider](classes/NotificationProvider.mdx)
|
|
- [Oauth](classes/Oauth.mdx)
|
|
- [Order](classes/Order.mdx)
|
|
- [OrderEdit](classes/OrderEdit.mdx)
|
|
- [OrderItemChange](classes/OrderItemChange.mdx)
|
|
- [Payment](classes/Payment.mdx)
|
|
- [PaymentCollection](classes/PaymentCollection.mdx)
|
|
- [PaymentProvider](classes/PaymentProvider.mdx)
|
|
- [PaymentSession](classes/PaymentSession.mdx)
|
|
- [PriceList](classes/PriceList.mdx)
|
|
- [Product](classes/Product.mdx)
|
|
- [ProductCategory](classes/ProductCategory.mdx)
|
|
- [ProductCollection](classes/ProductCollection.mdx)
|
|
- [ProductOption](classes/ProductOption.mdx)
|
|
- [ProductOptionValue](classes/ProductOptionValue.mdx)
|
|
- [ProductTag](classes/ProductTag.mdx)
|
|
- [ProductTaxRate](classes/ProductTaxRate.mdx)
|
|
- [ProductType](classes/ProductType.mdx)
|
|
- [ProductTypeTaxRate](classes/ProductTypeTaxRate.mdx)
|
|
- [ProductVariant](classes/ProductVariant.mdx)
|
|
- [ProductVariantInventoryItem](classes/ProductVariantInventoryItem.mdx)
|
|
- [ProductVariantMoneyAmount](classes/ProductVariantMoneyAmount.mdx)
|
|
- [PublishableApiKey](classes/PublishableApiKey.mdx)
|
|
- [PublishableApiKeySalesChannel](classes/PublishableApiKeySalesChannel.mdx)
|
|
- [Refund](classes/Refund.mdx)
|
|
- [Region](classes/Region.mdx)
|
|
- [Return](classes/Return.mdx)
|
|
- [ReturnItem](classes/ReturnItem.mdx)
|
|
- [ReturnReason](classes/ReturnReason.mdx)
|
|
- [SalesChannel](classes/SalesChannel.mdx)
|
|
- [SalesChannelLocation](classes/SalesChannelLocation.mdx)
|
|
- [ShippingMethod](classes/ShippingMethod.mdx)
|
|
- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.mdx)
|
|
- [ShippingOption](classes/ShippingOption.mdx)
|
|
- [ShippingOptionRequirement](classes/ShippingOptionRequirement.mdx)
|
|
- [ShippingProfile](classes/ShippingProfile.mdx)
|
|
- [ShippingTaxRate](classes/ShippingTaxRate.mdx)
|
|
- [SoftDeletableEntity](classes/SoftDeletableEntity.mdx)
|
|
- [StagedJob](classes/StagedJob.mdx)
|
|
- [Store](classes/Store.mdx)
|
|
- [Swap](classes/Swap.mdx)
|
|
- [TaxLine](classes/TaxLine.mdx)
|
|
- [TaxProvider](classes/TaxProvider.mdx)
|
|
- [TaxRate](classes/TaxRate.mdx)
|
|
- [TrackingLink](classes/TrackingLink.mdx)
|
|
- [User](classes/User.mdx)
|
|
|
|
## Interfaces
|
|
|
|
- [Boolean](interfaces/Boolean.mdx)
|
|
|
|
## Type Aliases
|
|
|
|
- [BatchJobResultError](types/BatchJobResultError.mdx)
|
|
- [BatchJobResultStatDescriptor](types/BatchJobResultStatDescriptor.mdx)
|
|
- [Record](types/Record.mdx)
|
|
|
|
## Functions
|
|
|
|
### Boolean
|
|
|
|
`**Boolean**<TypeParameter T>(value?): boolean`
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "T",
|
|
"type": "`object`",
|
|
"description": "",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|
|
|
|
#### Parameters
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "value",
|
|
"type": "`T`",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|
|
|
|
#### Returns
|
|
|
|
`boolean`
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "boolean",
|
|
"type": "`boolean`",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"description": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|