@commercelayer/sdk-utils
Version:
Commerce Layer Javascript SDK Utils library
1,216 lines (1,213 loc) • 48.7 kB
text/typescript
import { ResourceInclude } from './base.cjs';
import '@commercelayer/sdk';
declare class AddressInclude extends ResourceInclude {
get geocoder(): GeocoderInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class AdjustmentInclude extends ResourceInclude {
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class AdyenGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get adyen_payments(): AdyenPaymentInclude;
}
declare class AdyenPaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ApplicationInclude extends ResourceInclude {
}
declare class AttachmentInclude extends ResourceInclude {
get event_stores(): EventStoreInclude;
}
declare class AuthorizationInclude extends ResourceInclude {
get order(): OrderInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get captures(): CaptureInclude;
get voids(): VoidInclude;
}
declare class AvalaraAccountInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get tax_categories(): TaxCategoryInclude;
}
declare class AxerveGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get axerve_payments(): AxervePaymentInclude;
}
declare class AxervePaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class BillingInfoValidationRuleInclude extends ResourceInclude {
get market(): MarketInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class BingGeocoderInclude extends ResourceInclude {
get markets(): MarketInclude;
get addresses(): AddressInclude;
get attachments(): AttachmentInclude;
get event_stores(): EventStoreInclude;
}
declare class BraintreeGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get braintree_payments(): BraintreePaymentInclude;
}
declare class BraintreePaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class BundleInclude extends ResourceInclude {
get market(): MarketInclude;
get sku_list(): SkuListInclude;
get skus(): SkuInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class BuyXPayYPromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get skus(): SkuInclude;
}
declare class CaptureInclude extends ResourceInclude {
get order(): OrderInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get reference_authorization(): AuthorizationInclude;
get refunds(): RefundInclude;
get return(): ReturnInclude;
}
declare class CarrierAccountInclude extends ResourceInclude {
get market(): MarketInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CheckoutComGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get checkout_com_payments(): CheckoutComPaymentInclude;
}
declare class CheckoutComPaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CleanupInclude extends ResourceInclude {
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CouponInclude extends ResourceInclude {
get promotion_rule(): CouponCodesPromotionRuleInclude;
get coupon_recipient(): CouponRecipientInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CouponCodesPromotionRuleInclude extends ResourceInclude {
get promotion(): PromotionInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get coupons(): CouponInclude;
}
declare class CouponRecipientInclude extends ResourceInclude {
get customer(): CustomerInclude;
get event_stores(): EventStoreInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
}
declare class CustomPromotionRuleInclude extends ResourceInclude {
get promotion(): PromotionInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CustomerInclude extends ResourceInclude {
get customer_group(): CustomerGroupInclude;
get customer_addresses(): CustomerAddressInclude;
get customer_payment_sources(): CustomerPaymentSourceInclude;
get customer_subscriptions(): CustomerSubscriptionInclude;
get orders(): OrderInclude;
get order_subscriptions(): OrderSubscriptionInclude;
get returns(): ReturnInclude;
get sku_lists(): SkuListInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get jwt_customer(): CustomerInclude;
get jwt_markets(): MarketInclude;
get jwt_stock_locations(): StockLocationInclude;
get event_stores(): EventStoreInclude;
}
declare class CustomerAddressInclude extends ResourceInclude {
get customer(): CustomerInclude;
get address(): AddressInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CustomerGroupInclude extends ResourceInclude {
get customers(): CustomerInclude;
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CustomerPasswordResetInclude extends ResourceInclude {
get customer(): CustomerInclude;
get events(): EventInclude;
get event_stores(): EventStoreInclude;
}
declare class CustomerPaymentSourceInclude extends ResourceInclude {
get customer(): CustomerInclude;
get payment_method(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class CustomerSubscriptionInclude extends ResourceInclude {
get customer(): CustomerInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class DeliveryLeadTimeInclude extends ResourceInclude {
get stock_location(): StockLocationInclude;
get shipping_method(): ShippingMethodInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class DiscountEngineInclude extends ResourceInclude {
get markets(): MarketInclude;
get discount_engine_items(): DiscountEngineItemInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class DiscountEngineItemInclude extends ResourceInclude {
get discount_engine(): DiscountEngineInclude;
get order(): OrderInclude;
get event_stores(): EventStoreInclude;
}
declare class EasypostPickupInclude extends ResourceInclude {
get shipment(): ShipmentInclude;
get parcels(): ParcelInclude;
get events(): EventInclude;
get event_stores(): EventStoreInclude;
}
declare class EventInclude extends ResourceInclude {
get webhooks(): WebhookInclude;
get last_event_callbacks(): EventCallbackInclude;
get event_stores(): EventStoreInclude;
}
declare class EventCallbackInclude extends ResourceInclude {
get webhook(): WebhookInclude;
get event_stores(): EventStoreInclude;
}
declare class EventStoreInclude extends ResourceInclude {
}
declare class ExportInclude extends ResourceInclude {
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ExternalGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get external_payments(): ExternalPaymentInclude;
}
declare class ExternalPaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get wallet(): CustomerPaymentSourceInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ExternalPromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get skus(): SkuInclude;
}
declare class ExternalTaxCalculatorInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class FixedAmountPromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get skus(): SkuInclude;
}
declare class FixedPricePromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get skus(): SkuInclude;
}
declare class FlexPromotionInclude extends ResourceInclude {
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class FreeGiftPromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get skus(): SkuInclude;
}
declare class FreeShippingPromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class GeocoderInclude extends ResourceInclude {
get markets(): MarketInclude;
get addresses(): AddressInclude;
get attachments(): AttachmentInclude;
get event_stores(): EventStoreInclude;
}
declare class GiftCardInclude extends ResourceInclude {
get market(): MarketInclude;
get gift_card_recipient(): GiftCardRecipientInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class GiftCardRecipientInclude extends ResourceInclude {
get customer(): CustomerInclude;
get event_stores(): EventStoreInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
}
declare class GoogleGeocoderInclude extends ResourceInclude {
get markets(): MarketInclude;
get addresses(): AddressInclude;
get attachments(): AttachmentInclude;
get event_stores(): EventStoreInclude;
}
declare class ImportInclude extends ResourceInclude {
get events(): EventInclude;
get event_stores(): EventStoreInclude;
}
declare class InStockSubscriptionInclude extends ResourceInclude {
get market(): MarketInclude;
get customer(): CustomerInclude;
get sku(): SkuInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class InventoryModelInclude extends ResourceInclude {
get inventory_stock_locations(): InventoryStockLocationInclude;
get inventory_return_locations(): InventoryReturnLocationInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class InventoryReturnLocationInclude extends ResourceInclude {
get stock_location(): StockLocationInclude;
get inventory_model(): InventoryModelInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class InventoryStockLocationInclude extends ResourceInclude {
get stock_location(): StockLocationInclude;
get inventory_model(): InventoryModelInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class KlarnaGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get klarna_payments(): KlarnaPaymentInclude;
}
declare class KlarnaPaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class LineItemInclude extends ResourceInclude {
get order(): OrderInclude;
get sku(): SkuInclude;
get bundle(): BundleInclude;
get adjustment(): AdjustmentInclude;
get gift_card(): GiftCardInclude;
get shipment(): ShipmentInclude;
get payment_method(): PaymentMethodInclude;
get line_item_options(): LineItemOptionInclude;
get return_line_items(): ReturnLineItemInclude;
get shipment_line_items(): ShipmentLineItemInclude;
get stock_reservations(): StockReservationInclude;
get stock_line_items(): StockLineItemInclude;
get stock_transfers(): StockTransferInclude;
get notifications(): NotificationInclude;
get events(): EventInclude;
get tags(): TagInclude;
get event_stores(): EventStoreInclude;
}
declare class LineItemOptionInclude extends ResourceInclude {
get line_item(): LineItemInclude;
get sku_option(): SkuOptionInclude;
get events(): EventInclude;
get tags(): TagInclude;
get event_stores(): EventStoreInclude;
}
declare class LinkInclude extends ResourceInclude {
get events(): EventInclude;
get event_stores(): EventStoreInclude;
}
declare class ManualGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ManualTaxCalculatorInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get tax_rules(): TaxRuleInclude;
}
declare class MarketInclude extends ResourceInclude {
get merchant(): MerchantInclude;
get price_list(): PriceListInclude;
get base_price_list(): PriceListInclude;
get inventory_model(): InventoryModelInclude;
get subscription_model(): SubscriptionModelInclude;
get discount_engine(): DiscountEngineInclude;
get tax_calculator(): TaxCalculatorInclude;
get customer_group(): CustomerGroupInclude;
get geocoder(): GeocoderInclude;
get default_shipping_method(): ShippingMethodInclude;
get default_payment_method(): PaymentMethodInclude;
get stores(): StoreInclude;
get price_list_schedulers(): PriceListSchedulerInclude;
get order_validation_rules(): OrderValidationRuleInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class MerchantInclude extends ResourceInclude {
get address(): AddressInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class NotificationInclude extends ResourceInclude {
get event_stores(): EventStoreInclude;
}
declare class OrderInclude extends ResourceInclude {
get market(): MarketInclude;
get customer(): CustomerInclude;
get shipping_address(): AddressInclude;
get billing_address(): AddressInclude;
get store(): StoreInclude;
get default_shipping_method(): ShippingMethodInclude;
get default_payment_method(): PaymentMethodInclude;
get available_payment_methods(): PaymentMethodInclude;
get available_customer_payment_sources(): CustomerPaymentSourceInclude;
get available_free_skus(): SkuInclude;
get available_free_bundles(): BundleInclude;
get payment_method(): PaymentMethodInclude;
get discount_engine_item(): DiscountEngineItemInclude;
get line_items(): LineItemInclude;
get line_item_options(): LineItemOptionInclude;
get stock_reservations(): StockReservationInclude;
get stock_line_items(): StockLineItemInclude;
get stock_transfers(): StockTransferInclude;
get shipments(): ShipmentInclude;
get payment_options(): PaymentOptionInclude;
get transactions(): TransactionInclude;
get authorizations(): AuthorizationInclude;
get captures(): CaptureInclude;
get voids(): VoidInclude;
get refunds(): RefundInclude;
get returns(): ReturnInclude;
get order_subscription(): OrderSubscriptionInclude;
get order_subscriptions(): OrderSubscriptionInclude;
get order_factories(): OrderFactoryInclude;
get order_copies(): OrderCopyInclude;
get recurring_order_copies(): RecurringOrderCopyInclude;
get attachments(): AttachmentInclude;
get notifications(): NotificationInclude;
get links(): LinkInclude;
get resource_errors(): ResourceErrorInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class OrderAmountPromotionRuleInclude extends ResourceInclude {
get promotion(): PromotionInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class OrderCopyInclude extends ResourceInclude {
get source_order(): OrderInclude;
get target_order(): OrderInclude;
get events(): EventInclude;
get event_stores(): EventStoreInclude;
get order_subscription(): OrderSubscriptionInclude;
}
declare class OrderFactoryInclude extends ResourceInclude {
get source_order(): OrderInclude;
get target_order(): OrderInclude;
get events(): EventInclude;
get event_stores(): EventStoreInclude;
}
declare class OrderSubscriptionInclude extends ResourceInclude {
get market(): MarketInclude;
get subscription_model(): SubscriptionModelInclude;
get source_order(): OrderInclude;
get customer(): CustomerInclude;
get customer_payment_source(): CustomerPaymentSourceInclude;
get order_subscription_items(): OrderSubscriptionItemInclude;
get order_factories(): OrderFactoryInclude;
get order_copies(): OrderCopyInclude;
get recurring_order_copies(): RecurringOrderCopyInclude;
get orders(): OrderInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class OrderSubscriptionItemInclude extends ResourceInclude {
get order_subscription(): OrderSubscriptionInclude;
get sku(): SkuInclude;
get bundle(): BundleInclude;
get adjustment(): AdjustmentInclude;
get source_line_item(): LineItemInclude;
get event_stores(): EventStoreInclude;
}
declare class OrderValidationRuleInclude extends ResourceInclude {
get market(): MarketInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class OrganizationInclude extends ResourceInclude {
get event_stores(): EventStoreInclude;
}
declare class PackageInclude extends ResourceInclude {
get stock_location(): StockLocationInclude;
get parcels(): ParcelInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ParcelInclude extends ResourceInclude {
get shipment(): ShipmentInclude;
get package(): PackageInclude;
get parcel_line_items(): ParcelLineItemInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ParcelLineItemInclude extends ResourceInclude {
get parcel(): ParcelInclude;
get stock_line_item(): StockLineItemInclude;
get shipment_line_item(): ShipmentLineItemInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PaymentGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PaymentMethodInclude extends ResourceInclude {
get market(): MarketInclude;
get payment_gateway(): PaymentGatewayInclude;
get store(): StoreInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PaymentOptionInclude extends ResourceInclude {
get order(): OrderInclude;
get attachments(): AttachmentInclude;
get event_stores(): EventStoreInclude;
}
declare class PaypalGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get paypal_payments(): PaypalPaymentInclude;
}
declare class PaypalPaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PercentageDiscountPromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get skus(): SkuInclude;
}
declare class PickupInclude extends ResourceInclude {
get shipment(): ShipmentInclude;
get parcels(): ParcelInclude;
get events(): EventInclude;
get event_stores(): EventStoreInclude;
}
declare class PriceInclude extends ResourceInclude {
get price_list(): PriceListInclude;
get sku(): SkuInclude;
get price_tiers(): PriceTierInclude;
get price_volume_tiers(): PriceVolumeTierInclude;
get price_frequency_tiers(): PriceFrequencyTierInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get jwt_customer(): CustomerInclude;
get jwt_markets(): MarketInclude;
get jwt_stock_locations(): StockLocationInclude;
get event_stores(): EventStoreInclude;
}
declare class PriceFrequencyTierInclude extends ResourceInclude {
get price(): PriceInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get events(): EventInclude;
}
declare class PriceListInclude extends ResourceInclude {
get prices(): PriceInclude;
get price_list_schedulers(): PriceListSchedulerInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PriceListSchedulerInclude extends ResourceInclude {
get market(): MarketInclude;
get price_list(): PriceListInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PriceTierInclude extends ResourceInclude {
get price(): PriceInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PriceVolumeTierInclude extends ResourceInclude {
get price(): PriceInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get events(): EventInclude;
}
declare class PromotionInclude extends ResourceInclude {
get market(): MarketInclude;
get promotion_rules(): PromotionRuleInclude;
get order_amount_promotion_rule(): OrderAmountPromotionRuleInclude;
get sku_list_promotion_rule(): SkuListPromotionRuleInclude;
get coupon_codes_promotion_rule(): CouponCodesPromotionRuleInclude;
get custom_promotion_rule(): CustomPromotionRuleInclude;
get sku_list(): SkuListInclude;
get coupons(): CouponInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class PromotionRuleInclude extends ResourceInclude {
get promotion(): PromotionInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class RecurringOrderCopyInclude extends ResourceInclude {
get source_order(): OrderInclude;
get target_order(): OrderInclude;
get events(): EventInclude;
get event_stores(): EventStoreInclude;
get order_subscription(): OrderSubscriptionInclude;
}
declare class RefundInclude extends ResourceInclude {
get order(): OrderInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get reference_capture(): CaptureInclude;
get return(): ReturnInclude;
}
declare class ReservedStockInclude extends ResourceInclude {
get stock_item(): StockItemInclude;
get sku(): SkuInclude;
get stock_reservations(): StockReservationInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ResourceErrorInclude extends ResourceInclude {
get event_stores(): EventStoreInclude;
}
declare class ReturnInclude extends ResourceInclude {
get order(): OrderInclude;
get customer(): CustomerInclude;
get stock_location(): StockLocationInclude;
get origin_address(): AddressInclude;
get destination_address(): AddressInclude;
get reference_capture(): CaptureInclude;
get reference_refund(): RefundInclude;
get return_line_items(): ReturnLineItemInclude;
get attachments(): AttachmentInclude;
get resource_errors(): ResourceErrorInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ReturnLineItemInclude extends ResourceInclude {
get return(): ReturnInclude;
get line_item(): LineItemInclude;
get event_stores(): EventStoreInclude;
}
declare class SatispayGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get satispay_payments(): SatispayPaymentInclude;
}
declare class SatispayPaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShipmentInclude extends ResourceInclude {
get order(): OrderInclude;
get shipping_category(): ShippingCategoryInclude;
get inventory_stock_location(): InventoryStockLocationInclude;
get stock_location(): StockLocationInclude;
get origin_address(): AddressInclude;
get shipping_address(): AddressInclude;
get shipping_method(): ShippingMethodInclude;
get delivery_lead_time(): DeliveryLeadTimeInclude;
get pickup(): PickupInclude;
get shipment_line_items(): ShipmentLineItemInclude;
get stock_line_items(): StockLineItemInclude;
get stock_transfers(): StockTransferInclude;
get line_items(): LineItemInclude;
get available_shipping_methods(): ShippingMethodInclude;
get carrier_accounts(): CarrierAccountInclude;
get parcels(): ParcelInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShipmentLineItemInclude extends ResourceInclude {
get shipment(): ShipmentInclude;
get line_item(): LineItemInclude;
get stock_item(): StockItemInclude;
get sku(): SkuInclude;
get stock_reservation(): StockReservationInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShippingCategoryInclude extends ResourceInclude {
get skus(): SkuInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShippingMethodInclude extends ResourceInclude {
get market(): MarketInclude;
get shipping_zone(): ShippingZoneInclude;
get shipping_category(): ShippingCategoryInclude;
get stock_location(): StockLocationInclude;
get delivery_lead_time_for_shipment(): DeliveryLeadTimeInclude;
get shipping_method_tiers(): ShippingMethodTierInclude;
get shipping_weight_tiers(): ShippingWeightTierInclude;
get attachments(): AttachmentInclude;
get notifications(): NotificationInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShippingMethodTierInclude extends ResourceInclude {
get shipping_method(): ShippingMethodInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShippingWeightTierInclude extends ResourceInclude {
get shipping_method(): ShippingMethodInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class ShippingZoneInclude extends ResourceInclude {
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class SkuInclude extends ResourceInclude {
get shipping_category(): ShippingCategoryInclude;
get prices(): PriceInclude;
get stock_items(): StockItemInclude;
get stock_reservations(): StockReservationInclude;
get delivery_lead_times(): DeliveryLeadTimeInclude;
get sku_options(): SkuOptionInclude;
get sku_list_items(): SkuListItemInclude;
get sku_lists(): SkuListInclude;
get attachments(): AttachmentInclude;
get links(): LinkInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get jwt_customer(): CustomerInclude;
get jwt_markets(): MarketInclude;
get jwt_stock_locations(): StockLocationInclude;
get event_stores(): EventStoreInclude;
}
declare class SkuListInclude extends ResourceInclude {
get customer(): CustomerInclude;
get skus(): SkuInclude;
get sku_list_items(): SkuListItemInclude;
get bundles(): BundleInclude;
get attachments(): AttachmentInclude;
get links(): LinkInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class SkuListItemInclude extends ResourceInclude {
get sku_list(): SkuListInclude;
get sku(): SkuInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class SkuListPromotionRuleInclude extends ResourceInclude {
get promotion(): PromotionInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get sku_list(): SkuListInclude;
get skus(): SkuInclude;
}
declare class SkuOptionInclude extends ResourceInclude {
get market(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get tags(): TagInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StockItemInclude extends ResourceInclude {
get stock_location(): StockLocationInclude;
get sku(): SkuInclude;
get reserved_stock(): ReservedStockInclude;
get stock_reservations(): StockReservationInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StockLineItemInclude extends ResourceInclude {
get shipment(): ShipmentInclude;
get line_item(): LineItemInclude;
get stock_item(): StockItemInclude;
get sku(): SkuInclude;
get stock_reservation(): StockReservationInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StockLocationInclude extends ResourceInclude {
get address(): AddressInclude;
get inventory_stock_locations(): InventoryStockLocationInclude;
get inventory_return_locations(): InventoryReturnLocationInclude;
get stock_items(): StockItemInclude;
get stock_transfers(): StockTransferInclude;
get stores(): StoreInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StockReservationInclude extends ResourceInclude {
get line_item(): LineItemInclude;
get order(): OrderInclude;
get stock_line_item(): StockLineItemInclude;
get stock_transfer(): StockTransferInclude;
get stock_item(): StockItemInclude;
get reserved_stock(): ReservedStockInclude;
get sku(): SkuInclude;
get event_stores(): EventStoreInclude;
}
declare class StockTransferInclude extends ResourceInclude {
get sku(): SkuInclude;
get origin_stock_location(): StockLocationInclude;
get destination_stock_location(): StockLocationInclude;
get shipment(): ShipmentInclude;
get line_item(): LineItemInclude;
get stock_reservation(): StockReservationInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StoreInclude extends ResourceInclude {
get market(): MarketInclude;
get merchant(): MerchantInclude;
get stock_location(): StockLocationInclude;
get orders(): OrderInclude;
get payment_methods(): PaymentMethodInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StripeGatewayInclude extends ResourceInclude {
get payment_methods(): PaymentMethodInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get stripe_payments(): StripePaymentInclude;
}
declare class StripePaymentInclude extends ResourceInclude {
get order(): OrderInclude;
get payment_gateway(): PaymentGatewayInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class StripeTaxAccountInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get tax_categories(): TaxCategoryInclude;
}
declare class SubscriptionModelInclude extends ResourceInclude {
get markets(): MarketInclude;
get order_subscriptions(): OrderSubscriptionInclude;
get attachments(): AttachmentInclude;
get event_stores(): EventStoreInclude;
}
declare class TagInclude extends ResourceInclude {
get event_stores(): EventStoreInclude;
}
declare class TalonOneAccountInclude extends ResourceInclude {
get markets(): MarketInclude;
get discount_engine_items(): DiscountEngineItemInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class TaxCalculatorInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class TaxCategoryInclude extends ResourceInclude {
get sku(): SkuInclude;
get tax_calculator(): TaxCalculatorInclude;
get attachments(): AttachmentInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class TaxRuleInclude extends ResourceInclude {
get manual_tax_calculator(): ManualTaxCalculatorInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class TaxjarAccountInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get tax_categories(): TaxCategoryInclude;
}
declare class TransactionInclude extends ResourceInclude {
get order(): OrderInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class VersionInclude extends ResourceInclude {
get event_stores(): EventStoreInclude;
}
declare class VertexAccountInclude extends ResourceInclude {
get markets(): MarketInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class VoidInclude extends ResourceInclude {
get order(): OrderInclude;
get attachments(): AttachmentInclude;
get events(): EventInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
get reference_authorization(): AuthorizationInclude;
}
declare class WebhookInclude extends ResourceInclude {
get last_event_callbacks(): EventCallbackInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class WireTransferInclude extends ResourceInclude {
get order(): OrderInclude;
get versions(): VersionInclude;
get event_stores(): EventStoreInclude;
}
declare class IncludeHelper {
get addresses(): AddressInclude;
get adjustments(): AdjustmentInclude;
get adyen_gateways(): AdyenGatewayInclude;
get adyen_payments(): AdyenPaymentInclude;
get applications(): ApplicationInclude;
get attachments(): AttachmentInclude;
get authorizations(): AuthorizationInclude;
get avalara_accounts(): AvalaraAccountInclude;
get axerve_gateways(): AxerveGatewayInclude;
get axerve_payments(): AxervePaymentInclude;
get billing_info_validation_rules(): BillingInfoValidationRuleInclude;
get bing_geocoders(): BingGeocoderInclude;
get braintree_gateways(): BraintreeGatewayInclude;
get braintree_payments(): BraintreePaymentInclude;
get bundles(): BundleInclude;
get buy_x_pay_y_promotions(): BuyXPayYPromotionInclude;
get captures(): CaptureInclude;
get carrier_accounts(): CarrierAccountInclude;
get checkout_com_gateways(): CheckoutComGatewayInclude;
get checkout_com_payments(): CheckoutComPaymentInclude;
get cleanups(): CleanupInclude;
get coupons(): CouponInclude;
get coupon_codes_promotion_rules(): CouponCodesPromotionRuleInclude;
get coupon_recipients(): CouponRecipientInclude;
get custom_promotion_rules(): CustomPromotionRuleInclude;
get customers(): CustomerInclude;
get customer_addresses(): CustomerAddressInclude;
get customer_groups(): CustomerGroupInclude;
get customer_password_resets(): CustomerPasswordResetInclude;
get customer_payment_sources(): CustomerPaymentSourceInclude;
get customer_subscriptions(): CustomerSubscriptionInclude;
get delivery_lead_times(): DeliveryLeadTimeInclude;
get discount_engines(): DiscountEngineInclude;
get discount_engine_items(): DiscountEngineItemInclude;
get easypost_pickups(): EasypostPickupInclude;
get events(): EventInclude;
get event_callbacks(): EventCallbackInclude;
get event_stores(): EventStoreInclude;
get exports(): ExportInclude;
get external_gateways(): ExternalGatewayInclude;
get external_payments(): ExternalPaymentInclude;
get external_promotions(): ExternalPromotionInclude;
get external_tax_calculators(): ExternalTaxCalculatorInclude;
get fixed_amount_promotions(): FixedAmountPromotionInclude;
get fixed_price_promotions(): FixedPricePromotionInclude;
get flex_promotions(): FlexPromotionInclude;
get free_gift_promotions(): FreeGiftPromotionInclude;
get free_shipping_promotions(): FreeShippingPromotionInclude;
get geocoders(): GeocoderInclude;
get gift_cards(): GiftCardInclude;
get gift_card_recipients(): GiftCardRecipientInclude;
get google_geocoders(): GoogleGeocoderInclude;
get imports(): ImportInclude;
get in_stock_subscriptions(): InStockSubscriptionInclude;
get inventory_models(): InventoryModelInclude;
get inventory_return_locations(): InventoryReturnLocationInclude;
get inventory_stock_locations(): InventoryStockLocationInclude;
get klarna_gateways(): KlarnaGatewayInclude;
get klarna_payments(): KlarnaPaymentInclude;
get line_items(): LineItemInclude;
get line_item_options(): LineItemOptionInclude;
get links(): LinkInclude;
get manual_gateways(): ManualGatewayInclude;
get manual_tax_calculators(): ManualTaxCalculatorInclude;
get markets(): MarketInclude;
get merchants(): MerchantInclude;
get notifications(): NotificationInclude;
get orders(): OrderInclude;
get order_amount_promotion_rules(): OrderAmountPromotionRuleInclude;
get order_copies(): OrderCopyInclude;
get order_factories(): OrderFactoryInclude;
get order_subscriptions(): OrderSubscriptionInclude;
get order_subscription_items(): OrderSubscriptionItemInclude;
get order_validation_rules(): OrderValidationRuleInclude;
get organizations(): OrganizationInclude;
get packages(): PackageInclude;
get parcels(): ParcelInclude;
get parcel_line_items(): ParcelLineItemInclude;
get payment_gateways(): PaymentGatewayInclude;
get payment_methods(): PaymentMethodInclude;
get payment_options(): PaymentOptionInclude;
get paypal_gateways(): PaypalGatewayInclude;
get paypal_payments(): PaypalPaymentInclude;
get percentage_discount_promotions(): PercentageDiscountPromotionInclude;
get pickups(): PickupInclude;
get prices(): PriceInclude;
get price_frequency_tiers(): PriceFrequencyTierInclude;
get price_lists(): PriceListInclude;
get price_list_schedulers(): PriceListSchedulerInclude;
get price_tiers(): PriceTierInclude;
get price_volume_tiers(): PriceVolumeTierInclude;
get promotions(): PromotionInclude;
get promotion_rules(): PromotionRuleInclude;
get recurring_order_copies(): RecurringOrderCopyInclude;
get refunds(): RefundInclude;
get reserved_stocks(): ReservedStockInclude;
get resource_errors(): ResourceErrorInclude;
get returns(): ReturnInclude;
get return_line_items(): ReturnLineItemInclude;
get satispay_gateways(): SatispayGatewayInclude;
get satispay_payments(): SatispayPaymentInclude;
get shipments(): ShipmentInclude;
get shipment_line_items(): ShipmentLineItemInclude;
get shipping_categories(): ShippingCategoryInclude;
get shipping_methods(): ShippingMethodInclude;
get shipping_method_tiers(): ShippingMethodTierInclude;
get shipping_weight_tiers(): ShippingWeightTierInclude;
get shipping_zones(): ShippingZoneInclude;
get skus(): SkuInclude;
get sku_lists(): SkuListInclude;
get sku_list_items(): SkuListItemInclude;
get sku_list_promotion_rules(): SkuListPromotionRuleInclude;
get sku_options(): SkuOptionInclude;
get stock_items(): StockItemInclude;
get stock_line_items(): StockLineItemInclude;
get stock_locations(): StockLocationInclude;
get stock_reservations(): StockReservationInclude;
get stock_transfers(): StockTransferInclude;
get stores(): StoreInclude;
get stripe_gateways(): StripeGatewayInclude;
get stripe_payments(): StripePaymentInclude;
get stripe_tax_accounts(): StripeTaxAccountInclude;
get subscription_models(): SubscriptionModelInclude;
get tags(): TagInclude;
get talon_one_accounts(): TalonOneAccountInclude;
get tax_calculators(): TaxCalculatorInclude;
get tax_categories(): TaxCategoryInclude;
get tax_rules(): TaxRuleInclude;
get taxjar_accounts(): TaxjarAccountInclude;
get transactions(): TransactionInclude;
get versions(): VersionInclude;
get vertex_accounts(): VertexAccountInclude;
get voids(): VoidInclude;
get webhooks(): WebhookInclude;
get wire_transfers(): WireTransferInclude;
}
export { IncludeHelper };