@spree/sdk 0.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,786 @@
+type StoreAddress = {
+    id: string;
+    firstname: string | null;
+    lastname: string | null;
+    full_name: string;
+    address1: string | null;
+    address2: string | null;
+    city: string | null;
+    zipcode: string | null;
+    phone: string | null;
+    company: string | null;
+    country_name: string;
+    country_iso: string;
+    state_text: string | null;
+    state_abbr: string | null;
+    state_name: string | null;
+};
+
+type AdminMetafield = {
+    id: string;
+    name: string;
+    type: string;
+    key: string;
+    value: any;
+    display_on: string;
+};
+
+type AdminOrder = {
+    id: string;
+    number: string;
+    state: string;
+    token: string;
+    email: string | null;
+    special_instructions: string | null;
+    currency: string;
+    item_count: number;
+    shipment_state: string | null;
+    payment_state: string | null;
+    item_total: string;
+    display_item_total: string;
+    ship_total: string;
+    display_ship_total: string;
+    adjustment_total: string;
+    display_adjustment_total: string;
+    promo_total: string;
+    display_promo_total: string;
+    tax_total: string;
+    display_tax_total: string;
+    included_tax_total: string;
+    display_included_tax_total: string;
+    additional_tax_total: string;
+    display_additional_tax_total: string;
+    total: string;
+    display_total: string;
+    completed_at: string | null;
+    created_at: string;
+    updated_at: string;
+    order_promotions?: Array<StoreOrderPromotion>;
+    line_items?: Array<StoreLineItem>;
+    shipments?: Array<StoreShipment>;
+    payments?: Array<StorePayment>;
+    bill_address?: StoreAddress;
+    ship_address?: StoreAddress;
+    payment_methods: Array<StorePaymentMethod>;
+    channel: string | null;
+    last_ip_address: string | null;
+    considered_risky: boolean;
+    confirmation_delivered: boolean;
+    store_owner_notification_delivered: boolean;
+    internal_note: string | null;
+    approver_id: string | null;
+    canceled_at: string | null;
+    approved_at: string | null;
+    canceler_id: string | null;
+    created_by_id: string | null;
+    user?: AdminUser;
+};
+
+type AdminPrice = {
+    id: string;
+    amount: string | null;
+    amount_in_cents: number | null;
+    compare_at_amount: string | null;
+    compare_at_amount_in_cents: number | null;
+    currency: string | null;
+    display_amount: string | null;
+    display_compare_at_amount: string | null;
+    price_list_id: string | null;
+    variant_id: string | null;
+    created_at: string;
+    updated_at: string;
+};
+
+type AdminProduct = {
+    id: string;
+    name: string;
+    description: string | null;
+    slug: string;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    variant_count: number;
+    available_on: string | null;
+    created_at: string;
+    updated_at: string;
+    purchasable: boolean;
+    in_stock: boolean;
+    backorderable: boolean;
+    available: boolean;
+    default_variant_id: string;
+    thumbnail_url: string | null;
+    tags: Array<string>;
+    price: StorePrice;
+    original_price: StorePrice | null;
+    images?: Array<StoreImage>;
+    variants?: Array<AdminVariant>;
+    default_variant?: AdminVariant;
+    master_variant?: AdminVariant;
+    option_types?: Array<StoreOptionType>;
+    taxons?: Array<StoreTaxon>;
+    metafields?: Array<AdminMetafield>;
+    status: string;
+    make_active_at: string | null;
+    discontinue_on: string | null;
+    deleted_at: string | null;
+    cost_price: number | null;
+    cost_currency: string | null;
+};
+
+type AdminTaxon = {
+    id: string;
+    name: string;
+    permalink: string;
+    position: number;
+    depth: number;
+    meta_title: string | null;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    children_count: number;
+    created_at: string;
+    updated_at: string;
+    parent_id: string | null;
+    taxonomy_id: string;
+    description: string;
+    description_html: string;
+    image_url: string | null;
+    square_image_url: string | null;
+    is_root: boolean;
+    is_child: boolean;
+    is_leaf: boolean;
+    parent?: StoreTaxon;
+    children?: Array<StoreTaxon>;
+    ancestors?: Array<StoreTaxon>;
+    metafields?: Array<AdminMetafield>;
+    lft: number;
+    rgt: number;
+};
+
+type AdminTaxonomy = {
+    id: string;
+    name: string;
+    position: number;
+    created_at: string;
+    updated_at: string;
+    root_id: string | null;
+    root?: StoreTaxon;
+    taxons?: Array<StoreTaxon>;
+    metafields?: Array<AdminMetafield>;
+};
+
+type AdminUser = {
+    id: string;
+    email: string;
+    first_name: string | null;
+    last_name: string | null;
+    created_at: string;
+    updated_at: string;
+    addresses: Array<StoreAddress>;
+    default_billing_address: StoreAddress;
+    default_shipping_address: StoreAddress;
+    phone: string | null;
+    login: string | null;
+    accepts_email_marketing: boolean;
+    last_sign_in_at: string | null;
+    current_sign_in_at: string | null;
+    sign_in_count: number;
+    failed_attempts: number;
+    last_sign_in_ip: string | null;
+    current_sign_in_ip: string | null;
+    orders?: Array<AdminOrder>;
+};
+
+type AdminVariant = {
+    id: string;
+    product_id: string;
+    sku: string | null;
+    is_master: boolean;
+    options_text: string;
+    track_inventory: boolean;
+    image_count: number;
+    created_at: string;
+    updated_at: string;
+    thumbnail: string | null;
+    purchasable: boolean;
+    in_stock: boolean;
+    backorderable: boolean;
+    weight: number | null;
+    height: number | null;
+    width: number | null;
+    depth: number | null;
+    price: StorePrice;
+    original_price: StorePrice | null;
+    images?: Array<StoreImage>;
+    option_values: Array<StoreOptionValue>;
+    metafields?: Array<AdminMetafield>;
+    position: number;
+    tax_category_id: string | null;
+    deleted_at: string | null;
+    cost_price: number | null;
+    cost_currency: string | null;
+    total_on_hand: number | null;
+    prices?: Array<AdminPrice>;
+};
+
+type StoreBase = {
+    id: string;
+};
+
+type StoreCountry = {
+    iso: string;
+    iso3: string;
+    name: string;
+    states_required: boolean;
+    zipcode_required: boolean;
+    default_currency: string | null;
+    default_locale: string | null;
+    states?: Array<StoreState>;
+};
+
+type StoreCreditCard = {
+    id: string;
+    cc_type: string;
+    last_digits: string;
+    month: number;
+    year: number;
+    name: string | null;
+    default: boolean;
+};
+
+type StoreDigitalLink = {
+    id: string;
+    access_counter: number;
+    filename: string;
+    content_type: string;
+    created_at: string;
+    updated_at: string;
+    authorizable: boolean;
+    expired: boolean;
+    access_limit_exceeded: boolean;
+};
+
+type StoreGiftCard = {
+    id: string;
+    code: string;
+    state: string;
+    currency: string;
+    amount: number;
+    amount_used: number;
+    amount_authorized: number;
+    amount_remaining: number;
+    display_amount: string;
+    display_amount_used: string;
+    display_amount_remaining: string;
+    expires_at: string | null;
+    redeemed_at: string | null;
+    expired: boolean;
+    active: boolean;
+    created_at: string;
+    updated_at: string;
+};
+
+type StoreImage = {
+    id: string;
+    viewable_id: string;
+    position: number;
+    alt: string | null;
+    viewable_type: string;
+    created_at: string;
+    updated_at: string;
+    original_url: string | null;
+    mini_url: string | null;
+    small_url: string | null;
+    medium_url: string | null;
+    large_url: string | null;
+    xlarge_url: string | null;
+    og_image_url: string | null;
+};
+
+type StoreLineItem = {
+    id: string;
+    variant_id: string;
+    quantity: number;
+    name: string;
+    slug: string;
+    options_text: string;
+    price: string;
+    display_price: string;
+    total: string;
+    display_total: string;
+    adjustment_total: string;
+    display_adjustment_total: string;
+    additional_tax_total: string;
+    display_additional_tax_total: string;
+    included_tax_total: string;
+    display_included_tax_total: string;
+    promo_total: string;
+    display_promo_total: string;
+    pre_tax_amount: string;
+    display_pre_tax_amount: string;
+    discounted_amount: string;
+    display_discounted_amount: string;
+    display_compare_at_amount: string | null;
+    created_at: string;
+    updated_at: string;
+    compare_at_amount: string | null;
+    thumbnail_url: string | null;
+    option_values: Array<StoreOptionValue>;
+};
+
+type StoreMetafield = {
+    id: string;
+    name: string;
+    type: string;
+    key: string;
+    value: any;
+};
+
+type StoreOptionType = {
+    id: string;
+    name: string;
+    presentation: string;
+    position: number;
+};
+
+type StoreOptionValue = {
+    id: string;
+    option_type_id: string;
+    name: string;
+    presentation: string;
+    position: number;
+    option_type_name: string;
+    option_type_presentation: string;
+};
+
+type StoreOrderPromotion = {
+    id: string;
+    promotion_id: string;
+    name: string;
+    description: string | null;
+    code: string | null;
+    amount: string;
+    display_amount: string;
+};
+
+type StoreOrder = {
+    id: string;
+    number: string;
+    state: string;
+    token: string;
+    email: string | null;
+    special_instructions: string | null;
+    currency: string;
+    item_count: number;
+    shipment_state: string | null;
+    payment_state: string | null;
+    item_total: string;
+    display_item_total: string;
+    ship_total: string;
+    display_ship_total: string;
+    adjustment_total: string;
+    display_adjustment_total: string;
+    promo_total: string;
+    display_promo_total: string;
+    tax_total: string;
+    display_tax_total: string;
+    included_tax_total: string;
+    display_included_tax_total: string;
+    additional_tax_total: string;
+    display_additional_tax_total: string;
+    total: string;
+    display_total: string;
+    completed_at: string | null;
+    created_at: string;
+    updated_at: string;
+    order_promotions?: Array<StoreOrderPromotion>;
+    line_items?: Array<StoreLineItem>;
+    shipments?: Array<StoreShipment>;
+    payments?: Array<StorePayment>;
+    bill_address?: StoreAddress;
+    ship_address?: StoreAddress;
+    payment_methods: Array<StorePaymentMethod>;
+};
+
+type StorePaymentMethod = {
+    id: string;
+    name: string;
+    description: string | null;
+    type: string;
+};
+
+type StorePayment = {
+    id: string;
+    payment_method_id: string;
+    state: string;
+    response_code: string | null;
+    number: string;
+    amount: string;
+    display_amount: string;
+    created_at: string;
+    updated_at: string;
+    payment_method: StorePaymentMethod;
+};
+
+type StorePrice = {
+    id: string;
+    amount: string | null;
+    amount_in_cents: number | null;
+    compare_at_amount: string | null;
+    compare_at_amount_in_cents: number | null;
+    currency: string | null;
+    display_amount: string | null;
+    display_compare_at_amount: string | null;
+    price_list_id: string | null;
+};
+
+type StoreProduct = {
+    id: string;
+    name: string;
+    description: string | null;
+    slug: string;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    variant_count: number;
+    available_on: string | null;
+    created_at: string;
+    updated_at: string;
+    purchasable: boolean;
+    in_stock: boolean;
+    backorderable: boolean;
+    available: boolean;
+    default_variant_id: string;
+    thumbnail_url: string | null;
+    tags: Array<string>;
+    price: StorePrice;
+    original_price: StorePrice | null;
+    images?: Array<StoreImage>;
+    variants?: Array<StoreVariant>;
+    default_variant?: StoreVariant;
+    master_variant?: StoreVariant;
+    option_types?: Array<StoreOptionType>;
+    taxons?: Array<StoreTaxon>;
+    metafields?: Array<StoreMetafield>;
+};
+
+type StoreShipment = {
+    id: string;
+    number: string;
+    state: string;
+    tracking: string | null;
+    tracking_url: string | null;
+    cost: string;
+    display_cost: string;
+    shipped_at: string | null;
+    created_at: string;
+    updated_at: string;
+    shipping_method: StoreShippingMethod;
+    stock_location: StoreStockLocation;
+    shipping_rates: Array<StoreShippingRate>;
+};
+
+type StoreShippingMethod = {
+    id: string;
+    name: string;
+    code: string | null;
+};
+
+type StoreShippingRate = {
+    id: string;
+    shipping_method_id: string;
+    name: string;
+    selected: boolean;
+    cost: number;
+    display_cost: string;
+    shipping_method: StoreShippingMethod;
+};
+
+type StoreState = {
+    abbr: string;
+    name: string;
+};
+
+type StoreStockLocation = {
+    id: string;
+    state_abbr: string | null;
+    name: string;
+    address1: string | null;
+    city: string | null;
+    zipcode: string | null;
+    country_iso: string | null;
+    country_name: string | null;
+    state_text: string | null;
+};
+
+type StoreStore = {
+    id: string;
+    name: string;
+    url: string;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    seo_title: string | null;
+    default_currency: string;
+    code: string;
+    default: boolean;
+    facebook: string | null;
+    twitter: string | null;
+    instagram: string | null;
+    customer_support_email: string | null;
+    default_locale: string;
+    created_at: string;
+    updated_at: string;
+    default_country_iso: string | null;
+    supported_currencies: Array<string>;
+    favicon_image_url: string | null;
+    logo_image_url: string | null;
+    social_image_url: string | null;
+    supported_locales: Array<string>;
+    payment_methods: Array<StorePaymentMethod>;
+};
+
+type StoreTaxon = {
+    id: string;
+    name: string;
+    permalink: string;
+    position: number;
+    depth: number;
+    meta_title: string | null;
+    meta_description: string | null;
+    meta_keywords: string | null;
+    children_count: number;
+    created_at: string;
+    updated_at: string;
+    parent_id: string | null;
+    taxonomy_id: string;
+    description: string;
+    description_html: string;
+    image_url: string | null;
+    square_image_url: string | null;
+    is_root: boolean;
+    is_child: boolean;
+    is_leaf: boolean;
+    parent?: StoreTaxon;
+    children?: Array<StoreTaxon>;
+    ancestors?: Array<StoreTaxon>;
+    metafields?: Array<StoreMetafield>;
+};
+
+type StoreTaxonomy = {
+    id: string;
+    name: string;
+    position: number;
+    created_at: string;
+    updated_at: string;
+    root_id: string | null;
+    root?: StoreTaxon;
+    taxons?: Array<StoreTaxon>;
+    metafields?: Array<StoreMetafield>;
+};
+
+type StoreUser = {
+    id: string;
+    email: string;
+    first_name: string | null;
+    last_name: string | null;
+    created_at: string;
+    updated_at: string;
+    addresses: Array<StoreAddress>;
+    default_billing_address: StoreAddress;
+    default_shipping_address: StoreAddress;
+};
+
+type StoreVariant = {
+    id: string;
+    product_id: string;
+    sku: string | null;
+    is_master: boolean;
+    options_text: string;
+    track_inventory: boolean;
+    image_count: number;
+    created_at: string;
+    updated_at: string;
+    thumbnail: string | null;
+    purchasable: boolean;
+    in_stock: boolean;
+    backorderable: boolean;
+    weight: number | null;
+    height: number | null;
+    width: number | null;
+    depth: number | null;
+    price: StorePrice;
+    original_price: StorePrice | null;
+    images?: Array<StoreImage>;
+    option_values: Array<StoreOptionValue>;
+    metafields?: Array<StoreMetafield>;
+};
+
+type StoreWishedItem = {
+    id: string;
+    variant_id: string;
+    wishlist_id: string;
+    quantity: number;
+    created_at: string;
+    updated_at: string;
+    variant: StoreVariant;
+};
+
+type StoreWishlist = {
+    id: string;
+    name: string;
+    token: string;
+    created_at: string;
+    updated_at: string;
+    is_default: boolean;
+    is_private: boolean;
+    items?: Array<StoreWishedItem>;
+};
+
+interface PaginationMeta {
+    page: number;
+    limit: number;
+    count: number;
+    pages: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+interface ErrorResponse {
+    error: {
+        code: string;
+        message: string;
+        details?: Record<string, string[]>;
+    };
+}
+interface AuthTokens {
+    token: string;
+    user: {
+        id: string;
+        email: string;
+        first_name: string | null;
+        last_name: string | null;
+    };
+}
+interface LoginCredentials {
+    email: string;
+    password: string;
+}
+interface RegisterParams {
+    email: string;
+    password: string;
+    password_confirmation: string;
+    first_name?: string;
+    last_name?: string;
+}
+interface ListParams {
+    page?: number;
+    per_page?: number;
+    includes?: string;
+}
+interface ProductListParams extends ListParams {
+    'q[name_cont]'?: string;
+    'q[price_gte]'?: number;
+    'q[price_lte]'?: number;
+    'q[taxons_id_eq]'?: string;
+}
+interface TaxonListParams extends ListParams {
+    'q[taxonomy_id_eq]'?: string | number;
+    'q[parent_id_eq]'?: string | number;
+    'q[depth_eq]'?: number;
+    'q[name_cont]'?: string;
+}
+interface OrderListParams extends ListParams {
+    'q[state_eq]'?: string;
+    'q[completed_at_gte]'?: string;
+    'q[completed_at_lte]'?: string;
+}
+interface AddLineItemParams {
+    variant_id: string;
+    quantity: number;
+}
+interface UpdateLineItemParams {
+    quantity: number;
+}
+interface AddressParams {
+    firstname: string;
+    lastname: string;
+    address1: string;
+    address2?: string;
+    city: string;
+    zipcode: string;
+    phone?: string;
+    company?: string;
+    /** ISO 3166-1 alpha-2 country code (e.g., "US", "DE") */
+    country_iso: string;
+    /** ISO 3166-2 subdivision code without country prefix (e.g., "CA", "NY") */
+    state_abbr?: string;
+    /** State name - used for countries without predefined states */
+    state_name?: string;
+}
+interface UpdateOrderParams {
+    email?: string;
+    currency?: string;
+    special_instructions?: string;
+    /** Existing address ID to use */
+    bill_address_id?: string;
+    /** Existing address ID to use */
+    ship_address_id?: string;
+    /** New billing address */
+    bill_address?: AddressParams;
+    /** New shipping address */
+    ship_address?: AddressParams;
+}
+interface FilterOption {
+    id: string;
+    label: string;
+    count: number;
+}
+interface OptionFilterOption extends FilterOption {
+    name: string;
+    position: number;
+}
+interface TaxonFilterOption extends FilterOption {
+    permalink: string;
+}
+interface PriceRangeFilter {
+    id: 'price';
+    type: 'price_range';
+    label: string;
+    min: number;
+    max: number;
+    currency: string;
+}
+interface AvailabilityFilter {
+    id: 'availability';
+    type: 'availability';
+    label: string;
+    options: FilterOption[];
+}
+interface OptionFilter {
+    id: string;
+    type: 'option';
+    label: string;
+    name: string;
+    options: OptionFilterOption[];
+}
+interface TaxonFilter {
+    id: 'taxons';
+    type: 'taxon';
+    label: string;
+    options: TaxonFilterOption[];
+}
+type ProductFilter = PriceRangeFilter | AvailabilityFilter | OptionFilter | TaxonFilter;
+interface SortOption {
+    id: string;
+    label: string;
+}
+interface ProductFiltersResponse {
+    filters: ProductFilter[];
+    sort_options: SortOption[];
+    default_sort: string;
+    total_count: number;
+}
+interface ProductFiltersParams {
+    taxon_id?: string;
+    q?: Record<string, unknown>;
+}
+
+export type { AddLineItemParams, AddressParams, AdminMetafield, AdminOrder, AdminPrice, AdminProduct, AdminTaxon, AdminTaxonomy, AdminUser, AdminVariant, AuthTokens, AvailabilityFilter, ErrorResponse, FilterOption, ListParams, LoginCredentials, OptionFilter, OptionFilterOption, OrderListParams, PaginatedResponse, PaginationMeta, PriceRangeFilter, ProductFilter, ProductFiltersParams, ProductFiltersResponse, ProductListParams, RegisterParams, SortOption, StoreAddress, StoreBase, StoreCountry, StoreCreditCard, StoreDigitalLink, StoreGiftCard, StoreImage, StoreLineItem, StoreMetafield, StoreOptionType, StoreOptionValue, StoreOrder, StoreOrderPromotion, StorePayment, StorePaymentMethod, StorePrice, StoreProduct, StoreShipment, StoreShippingMethod, StoreShippingRate, StoreState, StoreStockLocation, StoreStore, StoreTaxon, StoreTaxonomy, StoreUser, StoreVariant, StoreWishedItem, StoreWishlist, TaxonFilter, TaxonFilterOption, TaxonListParams, UpdateLineItemParams, UpdateOrderParams };