@adtrackify/at-service-common 3.19.8 → 3.19.9

package/dist/esm/types/shopify-rest-types.d.ts

@@ -1,767 +0,0 @@
-export type LineItemFulfillmentStatus = 'fulfilled' | 'not_eligible' | 'partial' | null;
-export type WebhookTopic = 'app/uninstalled' | 'app_subscriptions/update' | 'bulk_operations/finish' | 'carts/create' | 'carts/update' | 'checkouts/create' | 'checkouts/delete' | 'checkouts/update' | 'customers/create' | 'customers/delete' | 'customers/disable' | 'customers/enable' | 'customers/update' | 'draft_orders/create' | 'draft_orders/delete' | 'draft_orders/update' | 'fulfillments/create' | 'fulfillments/update' | 'inventory_items/create' | 'inventory_items/delete' | 'inventory_items/update' | 'inventory_levels/connect' | 'inventory_levels/disconnect' | 'inventory_levels/update' | 'orders/cancelled' | 'orders/create' | 'orders/delete' | 'orders/edited' | 'orders/fulfilled' | 'orders/paid' | 'orders/partially_fulfilled' | 'orders/updated' | 'products/create' | 'products/delete' | 'products/update' | 'refunds/create' | 'shop/update' | 'themes/create' | 'themes/delete' | 'themes/publish' | 'themes/update' | string;
-export type WebhookFormat = 'json' | 'xml';
-export type RecurringApplicationChargeStatus = 'accepted' | 'active' | 'cancelled' | 'declined' | 'expired' | 'frozen' | 'pending';
-export type ProductVariantInventoryPolicy = 'deny' | 'continue';
-export type ProductVariantWeightUnit = 'g' | 'kg' | 'oz' | 'lb';
-export type ProductStatus = 'active' | 'archived' | 'draft';
-export interface IShop {
-    address1: string;
-    address2: string;
-    city: string;
-    country: string;
-    country_code: string;
-    country_name: string;
-    created_at: string;
-    county_taxes: string;
-    customer_email: string | null;
-    currency: string;
-    domain: string;
-    eligible_for_card_reader_giveaway: boolean;
-    eligible_for_payments: boolean;
-    enabled_presentment_currencies: string[];
-    email: string;
-    finances: boolean;
-    force_ssl?: boolean;
-    google_apps_domain: string | null;
-    google_apps_login_enabled: any | null;
-    has_discounts: boolean;
-    has_gift_cards: boolean;
-    has_storefront: boolean;
-    iana_timezone: string;
-    id: number;
-    latitude: number;
-    longitude: number;
-    money_format: string;
-    money_in_emails_format: string;
-    money_with_currency_format: string;
-    money_with_currency_in_emails_format: string;
-    myshopify_domain: string;
-    name: string;
-    password_enabled: boolean;
-    phone: string | null;
-    plan_display_name: string;
-    plan_name: string;
-    pre_launch_enabled: boolean;
-    primary_locale: string;
-    primary_location_id: number;
-    province: string;
-    province_code: string;
-    requires_extra_payments_agreement: boolean;
-    setup_required: boolean;
-    shop_owner: string;
-    source: string | null;
-    tax_shipping: boolean | null;
-    taxes_included: true | null;
-    timezone: string;
-    updated_at: string;
-    weight_unit: string;
-    zip: string;
-}
-export interface IOrder {
-    app_id: number;
-    billing_address: IAddress;
-    browser_ip: string | null;
-    buyer_accepts_marketing: boolean;
-    cancel_reason: 'customer' | 'declined' | 'fraud' | 'inventory' | 'other';
-    cancelled_at: string | null;
-    cart_token: string;
-    client_details: IOrderClientDetails;
-    closed_at: string | null;
-    confirmed: boolean;
-    created_at: string;
-    currency: string;
-    current_subtotal_price: string;
-    current_subtotal_price_set: IMoneySet;
-    current_total_discounts: string;
-    current_total_discounts_set: IMoneySet;
-    current_total_duties_set: null | IMoneySet;
-    current_total_price: string;
-    current_total_price_set: IMoneySet;
-    current_total_tax: string;
-    current_total_tax_set: IMoneySet;
-    customer?: ICustomer;
-    customer_locale: string;
-    discount_applications: IDiscountApplication[];
-    discount_codes: IOrderDiscountCode[];
-    email: string;
-    contact_email: string | null;
-    financial_status: 'authorized' | 'paid' | 'partially_paid' | 'partially_refunded' | 'pending' | 'refunded' | 'voided';
-    fulfillments: IFulfillment[];
-    fulfillment_status: 'fulfilled' | 'partial' | 'restocked' | null;
-    gateway: string;
-    id: number;
-    landing_site: string;
-    line_items: IOrderLineItem[];
-    location_id: number | null;
-    name: string;
-    note: string | null;
-    note_attributes: INoteAttribute[];
-    number: number;
-    order_number: number;
-    order_status_url: string;
-    payment_details?: IPaymentDetails;
-    payment_gateway_names: string[];
-    phone: string;
-    presentment_currency: string;
-    processed_at: string;
-    checkout_id: number;
-    processing_method: 'checkout' | 'direct' | 'express' | 'manual' | 'offsite';
-    referring_site: string;
-    refunds: IRefund[];
-    shipping_address: IAddress;
-    shipping_lines: IShippingLine[];
-    source_identifier: string | null;
-    source_name: 'web' | 'pos' | 'shopify_draft_order' | 'iphone' | 'android' | string;
-    subtotal_price: string;
-    subtotal_price_set: IMoneySet;
-    tags: string;
-    tax_lines: ITaxLine[];
-    taxes_included: boolean;
-    test: boolean;
-    token: string;
-    total_discounts: string;
-    total_discounts_set: IMoneySet;
-    total_line_items_price: string;
-    total_line_items_price_set: IMoneySet;
-    total_price: string;
-    total_price_set: IMoneySet;
-    total_shipping_price_set: IMoneySet;
-    total_tax: string;
-    total_tax_set: IMoneySet;
-    total_tip_received: string;
-    total_weight: number;
-    updated_at: string;
-    user_id: number | null;
-}
-export interface IProduct {
-    id: number;
-    title: string;
-    body_html: string;
-    vendor: string;
-    product_type: string;
-    created_at: string;
-    handle: string;
-    updated_at: string;
-    published_at: string;
-    template_suffix: string | null;
-    published_scope: string;
-    tags: string;
-    status: ProductStatus;
-    variants: IProductVariant[];
-    options: IProductOption[];
-    images: IProductImage[];
-    image: IProductImage;
-    metafields_global_title_tag?: string;
-    metafields_global_description_tag?: string;
-    admin_graphql_api_id?: string;
-}
-export interface IRecurringApplicationCharge {
-    id: number;
-    name: string;
-    price: string;
-    status: RecurringApplicationChargeStatus;
-    return_url: string;
-    billing_on: string | null;
-    created_at: string;
-    updated_at: string;
-    test: boolean | null;
-    activated_on: string | null;
-    cancelled_on: string | null;
-    trial_days: number;
-    trial_ends_on: string;
-    confirmation_url: string;
-    capped_amount: number;
-    terms: string;
-    api_client_id?: number;
-    decorated_return_url?: string;
-    balance_used?: number;
-    balance_remaining?: number;
-    risk_level?: number;
-}
-export interface IUsageCharge {
-    id: number;
-    description: string;
-    price: string;
-    created_at: string;
-    updated_at: string;
-    billing_on: string;
-    balance_used: number;
-    balance_remaining: number;
-    risk_level: number;
-    recurring_application_charge_id: number;
-}
-export interface IWebhook {
-    id: number;
-    address: string;
-    topic: WebhookTopic;
-    created_at: string;
-    updated_at: string;
-    format: WebhookFormat;
-    fields: string[];
-    metafield_namespaces: string[];
-    api_version?: string;
-    private_metafield_namespaces?: string[];
-}
-export interface ICheckout {
-    abandoned_checkout_url: string;
-    applied_discount?: ICheckoutDiscount;
-    billing_address?: ICustomerAddress;
-    buyer_accepts_marketing: boolean;
-    buyer_accepts_sms_marketing?: boolean;
-    cancel_reason?: 'customer' | 'fraud' | 'inventory' | 'other' | null;
-    cart_token: string;
-    closed_at: string | null;
-    completed_at: string | null;
-    created_at: string;
-    currency: string;
-    customer: ICustomer;
-    customer_id: number;
-    customer_locale: string;
-    device_id: number | null;
-    discount_code?: string;
-    discount_codes?: ICheckoutDiscount[];
-    email: string;
-    gateway: string | null;
-    gift_cards?: ICheckoutGiftCard;
-    id: number;
-    landing_site: string;
-    line_items: ICheckoutLineItem[];
-    location_id: number | null;
-    name?: string;
-    note: string | null;
-    note_attributes: INoteAttribute[];
-    order?: ICheckoutOrder;
-    payment_due: string;
-    payment_url?: string;
-    phone: string | null;
-    presentment_currency: string;
-    referring_site: string;
-    request_details?: ICheckoutRequestDetails;
-    requires_shipping?: boolean;
-    reservation_time?: number;
-    reservation_time_left?: number;
-    shipping_address: ICustomerAddress;
-    shipping_lines: ICheckoutShippingLine[];
-    shipping_rates?: ICheckoutShippingRate[];
-    shipping_rate?: ICheckoutShippingRate[];
-    sms_marketing_phone?: string;
-    source?: string;
-    source_identifier: string | null;
-    source_name: string | null;
-    source_url: string | null;
-    subtotal_price: string;
-    tax_lines: ICheckoutTaxLine[];
-    taxes_included: boolean;
-    token: string;
-    total_discounts: string;
-    total_line_items_price: string;
-    total_price: string;
-    total_tax: string;
-    total_weight: number;
-    updated_at: string;
-    user_id: number | null;
-    web_url?: string;
-}
-export type CustomerState = 'declined' | 'disabled' | 'enabled' | 'invited';
-export interface ICustomer {
-    accepts_marketing: boolean;
-    accepts_marketing_updated_at?: string;
-    addresses?: ICustomerAddress[];
-    admin_graphql_api_id?: string;
-    created_at: string;
-    currency: string;
-    default_address: ICustomerAddress;
-    email: string;
-    first_name: string;
-    id: number;
-    last_name: string;
-    last_order_id: number | null;
-    last_order_name: string | null;
-    marketing_opt_in_level?: string;
-    metafield?: IObjectMetafield;
-    multipass_identifier: null;
-    note: string | null;
-    orders_count: number;
-    phone: string;
-    state: CustomerState;
-    tags: string;
-    tax_exempt: boolean;
-    tax_exemptions?: string[];
-    total_spent: string;
-    updated_at: string;
-    verified_email: boolean;
-}
-export interface ICustomerAddress {
-    address1: string;
-    address2?: string;
-    city: string;
-    company: string | null;
-    country: string;
-    country_code: string;
-    country_name: string;
-    customer_id: number;
-    default: boolean;
-    first_name: string;
-    id: number;
-    last_name: string;
-    latitude: number | null;
-    longitude: number | null;
-    name: string;
-    phone: string | null;
-    province: string | null;
-    province_code: string | null;
-    zip: string;
-}
-export interface IOrderLineItem {
-    id: number;
-    discount_allocations: IDiscountAllocation[];
-    fulfillable_quantity: number;
-    fulfillment_service: string;
-    fulfillment_status: LineItemFulfillmentStatus;
-    gift_card: boolean;
-    grams: number;
-    name: string;
-    price: string;
-    price_set: IMoneySet;
-    product_id: number | null;
-    properties: ILineItemProperty[];
-    quantity: number;
-    requires_shipping: boolean;
-    sku: string;
-    taxable: boolean;
-    tax_lines: ITaxLine[];
-    title: string;
-    total_discount: string;
-    total_discount_set: IMoneySet;
-    variant_id: number | null;
-    variant_title: string;
-    vendor: string;
-    pre_tax_price?: string;
-    pre_tax_price_set?: IMoneySet;
-    tip_payment_gateway?: string;
-    tip_payment_method?: string;
-    admin_graphql_api_id?: string;
-    attributed_staffs?: IAttributedStaff[];
-    product_exists?: boolean;
-    variant_inventory_management?: string;
-    duties?: IDuty[];
-}
-export interface IRefund {
-    id: number;
-    created_at: string;
-    note: string;
-    order_id: number;
-    processed_at: string;
-    restock: string;
-    user_id: string;
-    order_adjustments: IOrderAdjustment[];
-    transactions: ITransaction[];
-    refund_line_items: IRefundLineItem[];
-    admin_graphql_api_id?: string;
-    total_duties_set?: IMoneySet;
-    duties?: IRefundDuty[];
-}
-export interface IRefundLineItem {
-    id: number;
-    line_item: IOrderLineItem;
-    line_item_id: number;
-    quantity: number;
-    restock_type: 'no_restock' | 'cancel' | 'return' | 'legacy_restock';
-    location_id: number;
-    subtotal: string;
-    total_tax: string;
-    subtotal_set: IMoneySet;
-    total_tax_set: IMoneySet;
-}
-interface IOrderClientDetails {
-    accept_language: string | null;
-    browser_height: number | null;
-    browser_ip: string | null;
-    browser_width: number | null;
-    session_hash: string | null;
-    user_agent: string | null;
-}
-type OrderDiscountCodeType = 'fixed_amount' | 'percentage' | 'shipping';
-interface IOrderDiscountCode {
-    amount: number;
-    code: string;
-    type: OrderDiscountCodeType;
-}
-interface IPaymentDetails {
-    avs_result_code: string | null;
-    credit_card_bin: string | null;
-    credit_card_company: string;
-    credit_card_number: string;
-    cvv_result_code: string | null;
-}
-interface IObjectMetafield {
-    key: string;
-    namespace: string;
-    value: string | number;
-    value_type: 'string' | 'integer';
-    description: string | null;
-}
-interface ICheckoutDiscount {
-    amount: string;
-    applicable: boolean;
-    description: string;
-    non_applicable_reason: string;
-    title: string;
-    value: string;
-    value_type: 'fixed_amount' | 'percentage';
-}
-interface ICheckoutGiftCard {
-    amount_used: string;
-    balance: string;
-    id: string;
-    last_characters: string;
-}
-interface ICheckoutOrder {
-    id: number;
-    name: string;
-    status_url: string;
-}
-interface ICheckoutRequestDetails {
-    accept_language: string;
-    ip_address: string;
-    user_agent: string;
-}
-interface ICheckoutShippingLine {
-    api_client_id: number | null;
-    applied_discounts: any[];
-    carrier_identifier: any | null;
-    carrier_service_id: number | null;
-    code: string;
-    delivery_category: any | null;
-    id: string;
-    markup: string;
-    phone: string | null;
-    price: string;
-    requested_fulfillment_service_id: number | null;
-    source: string;
-    tax_lines: any[];
-    title: string;
-    validation_context: any | null;
-}
-interface ICheckoutShippingRateCheckout {
-    subtotal_price: string;
-    total_price: string;
-    total_tax: string;
-}
-interface ICheckoutShippingRate {
-    checkout: ICheckoutShippingRateCheckout;
-    delivery_range: string[];
-    handle: string;
-    price: string;
-    requires_phone: boolean;
-    title: string;
-}
-interface ICheckoutTaxLine {
-    compare_at: number;
-    position: number;
-    price: string;
-    rate: number;
-    source: string;
-    title: string;
-    zone: string;
-}
-interface IObjectMetafield {
-    key: string;
-    namespace: string;
-    value: string | number;
-    value_type: 'string' | 'integer';
-    description: string | null;
-}
-interface IOrderClientDetails {
-    accept_language: string | null;
-    browser_height: number | null;
-    browser_ip: string | null;
-    browser_width: number | null;
-    session_hash: string | null;
-    user_agent: string | null;
-}
-interface IOrderDiscountCode {
-    amount: number;
-    code: string;
-    type: 'fixed_amount' | 'percentage' | 'shipping';
-}
-interface IPaymentDetails {
-    avs_result_code: string | null;
-    credit_card_bin: string | null;
-    credit_card_company: string;
-    credit_card_number: string;
-    cvv_result_code: string | null;
-}
-interface IMoneySet {
-    shop_money: IMoney;
-    presentment_money: IMoney;
-}
-interface IMoney {
-    amount: string;
-    currency_code: string;
-}
-interface IAddress {
-    id?: number;
-    customer_id?: number;
-    first_name?: string;
-    last_name?: string;
-    company?: string;
-    address1?: string;
-    address2?: string;
-    city?: string;
-    province?: string;
-    country?: string;
-    zip?: string;
-    phone?: string;
-    name?: string;
-    province_code?: string;
-    country_code?: string;
-    country_name?: string;
-    default?: boolean;
-    latitude?: number;
-    longitude?: number;
-}
-interface IAttributedStaff {
-    id?: string;
-    quantity?: number;
-}
-interface ILineItemProperty {
-    name?: string;
-    value?: string;
-}
-interface IDuty {
-    id?: string;
-    harmonized_system_code?: string;
-    country_code_of_origin?: string;
-    shop_money?: IMoney;
-    presentment_money?: IMoney;
-    tax_lines?: ITaxLine[];
-    admin_graphql_api_id?: string;
-}
-interface IDiscountAllocation {
-    amount?: string;
-    amount_set?: IMoneySet;
-    discount_application_index?: number;
-}
-interface IOrderAdjustment {
-    id?: number;
-    order_id?: number;
-    refund_id?: number;
-    amount?: string;
-    tax_amount?: string;
-    kind?: string;
-    reason?: string;
-    amount_set?: IMoneySet;
-    tax_amount_set?: IMoneySet;
-}
-interface ITransaction {
-    id?: number;
-    admin_graphql_api_id?: string;
-    amount?: string;
-    authorization?: string;
-    created_at?: string;
-    currency?: string;
-    device_id?: number;
-    error_code?: string;
-    gateway?: string;
-    kind?: string;
-    location_id?: number;
-    message?: string;
-    order_id?: number;
-    parent_id?: number;
-    processed_at?: string;
-    receipt?: Record<string, unknown>;
-    source_name?: string;
-    status?: string;
-    test?: boolean;
-    user_id?: number;
-}
-interface IRefundDuty {
-    duty_id?: number;
-    refund_type?: 'FULL' | 'PROPORTIONAL';
-}
-interface ICheckoutLineItem {
-    applied_discounts: IAppliedDiscount[];
-    compare_at_price: string | null;
-    destination_location_id: number;
-    discount_codes: IDiscountCode[];
-    fulfillment_service: 'api' | 'custom' | 'legacy' | 'manual';
-    fulfillment_status?: 'fulfilled' | 'partial' | null;
-    gift_card: boolean;
-    grams: number;
-    key: string;
-    line_price: string;
-    name: string;
-    origin_location_id: number;
-    price: string;
-    product_id: number;
-    properties: Record<string, string> | null;
-    quantity: number;
-    requires_shipping: boolean;
-    sku: string;
-    taxable: boolean;
-    tax_lines: ITaxLine[];
-    title: string;
-    variant_id: number;
-    variant_title: string;
-    vendor: string;
-    id?: string;
-    image_url?: string;
-    discount_allocations?: IDiscountAllocation[];
-}
-interface IAppliedDiscount {
-    title?: string;
-    description?: string;
-    value?: string;
-    value_type?: string;
-    amount?: string;
-}
-interface ILineItem {
-    id: number;
-    fulfillable_quantity: number;
-    fulfillment_service: string;
-    fulfillment_status: LineItemFulfillmentStatus;
-    gift_card: boolean;
-    grams: number;
-    name: string;
-    price: string;
-    product_exists: boolean;
-    product_id: number;
-    properties: ILineItemProperty[];
-    quantity: number;
-    requires_shipping: boolean;
-    sku: string;
-    taxable: boolean;
-    title: string;
-    total_discount: string;
-    variant_id: number;
-    variant_inventory_management: string;
-    variant_title: string;
-    vendor: string | null;
-    tax_lines: ITaxLine[];
-    admin_graphql_api_id?: string;
-    attributed_staffs?: IAttributedStaff[];
-    price_set?: IMoneySet;
-    total_discount_set?: IMoneySet;
-    duties?: IDuty[];
-    discount_allocations?: IDiscountAllocation[];
-}
-interface IDiscountApplication {
-    type?: string;
-    value?: string;
-    value_type?: string;
-    allocation_method?: string;
-    target_selection?: string;
-    target_type?: string;
-    description?: string;
-    title?: string;
-    code?: string;
-}
-interface IDiscountCode {
-    code?: string;
-    amount?: string;
-    type?: string;
-}
-interface IFulfillment {
-    id?: number;
-    admin_graphql_api_id?: string;
-    created_at?: string;
-    location_id?: number;
-    name?: string;
-    order_id?: number;
-    origin_address?: IAddress;
-    receipt?: Record<string, unknown>;
-    service?: string;
-    shipment_status?: string;
-    status?: string;
-    tracking_company?: string;
-    tracking_number?: string;
-    tracking_numbers?: string[];
-    tracking_url?: string;
-    tracking_urls?: string[];
-    updated_at?: string;
-    line_items?: ILineItem[];
-}
-interface INoteAttribute {
-    name?: string;
-    value?: string;
-}
-interface IShippingLine {
-    id?: number;
-    carrier_identifier?: string;
-    code?: string;
-    delivery_category?: string;
-    discounted_price?: string;
-    discounted_price_set?: IMoneySet;
-    phone?: string;
-    price?: string;
-    price_set?: IMoneySet;
-    requested_fulfillment_service_id?: string;
-    source?: string;
-    title?: string;
-    tax_lines?: ITaxLine[];
-    discount_allocations?: IDiscountAllocation[];
-}
-interface ITaxLine {
-    price?: string;
-    rate?: number;
-    title?: string;
-    price_set?: IMoneySet;
-    channel_liable?: boolean;
-}
-interface IProductVariantPresentmentPriceSet {
-    price: IMoney;
-    compare_at_price: IMoney;
-}
-interface IProductVariant {
-    id: number;
-    product_id: number;
-    title: string;
-    price: string;
-    sku: string;
-    position: number;
-    inventory_policy: ProductVariantInventoryPolicy;
-    compare_at_price: string | null;
-    fulfillment_service: string;
-    inventory_management: string;
-    option1: string | null;
-    option2: string | null;
-    option3: string | null;
-    created_at: string;
-    updated_at: string;
-    taxable: boolean;
-    barcode: string;
-    grams: number;
-    weight: number;
-    weight_unit: ProductVariantWeightUnit;
-    inventory_item_id: number;
-    inventory_quantity: number;
-    old_inventory_quantity: number;
-    requires_shipping: boolean;
-    image_id: number | null;
-    tax_code: string | null;
-    presentment_prices: IProductVariantPresentmentPriceSet[];
-    admin_graphql_api_id?: string;
-}
-interface IProductOption {
-    id: number;
-    product_id: number;
-    name: string;
-    position: number;
-    values: string[];
-}
-interface IProductImage {
-    id: number;
-    product_id: number;
-    position: number;
-    created_at: string;
-    updated_at: string;
-    alt: string | null;
-    width: number;
-    height: number;
-    src: string;
-    variant_ids: number[];
-    admin_graphql_api_id?: string;
-}
-export {};