@spree/sdk 0.5.0 → 0.6.1

package/dist/types/index.d.ts

@@ -38,6 +38,40 @@ type AdminCustomer = {
     orders?: Array<AdminOrder>;
 };
 
+type AdminLineItem = {
+    id: string;
+    variant_id: string;
+    quantity: number;
+    currency: string;
+    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>;
+    digital_links: Array<StoreDigitalLink>;
+    metadata: Record<string, unknown> | null;
+};
+
 type AdminMetafield = {
     id: string;
     name: string;
@@ -55,6 +89,7 @@ type AdminOrder = {
     email: string | null;
     special_instructions: string | null;
     currency: string;
+    locale: string | null;
     item_count: number;
     shipment_state: string | null;
     payment_state: string | null;
@@ -78,7 +113,7 @@ type AdminOrder = {
     created_at: string;
     updated_at: string;
     order_promotions: Array<StoreOrderPromotion>;
-    line_items: Array<StoreLineItem>;
+    line_items: Array<AdminLineItem>;
     shipments: Array<StoreShipment>;
     payments: Array<StorePayment>;
     bill_address: StoreAddress | null;
@@ -93,6 +128,7 @@ type AdminOrder = {
     approver_id: string | null;
     canceled_at: string | null;
     approved_at: string | null;
+    metadata: Record<string, unknown> | null;
     canceler_id: string | null;
     created_by_id: string | null;
     user?: AdminCustomer;
@@ -221,6 +257,17 @@ type AdminVariant = {
     prices?: Array<AdminPrice>;
 };
 
+type StoreAsset = {
+    id: string;
+    viewable_id: string;
+    type: string | null;
+    viewable_type: string;
+    position: number | null;
+    alt: string | null;
+    created_at: string;
+    updated_at: string;
+};
+
 type StoreBase = {
     id: string;
 };
@@ -254,6 +301,14 @@ type StoreCurrency = {
     symbol: string;
 };
 
+type StoreCustomerReturn = {
+    id: string;
+    number: string;
+    created_at: string;
+    updated_at: string;
+    stock_location_id: string | null;
+};
+
 type StoreCustomer = {
     id: string;
     email: string;
@@ -279,6 +334,35 @@ type StoreDigitalLink = {
     access_limit_exceeded: boolean;
 };
 
+type StoreDigital = {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    variant_id: string | null;
+};
+
+type StoreExport = {
+    id: string;
+    number: string;
+    type: string | null;
+    format: string | null;
+    created_at: string;
+    updated_at: string;
+    user_id: string | null;
+};
+
+type StoreGiftCardBatch = {
+    id: string;
+    codes_count: number;
+    currency: string | null;
+    prefix: string | null;
+    created_at: string;
+    updated_at: string;
+    amount: string | null;
+    expires_at: string | null;
+    created_by_id: string | null;
+};
+
 type StoreGiftCard = {
     id: string;
     code: string;
@@ -302,9 +386,10 @@ type StoreGiftCard = {
 type StoreImage = {
     id: string;
     viewable_id: string;
-    position: number;
-    alt: string | null;
+    type: string | null;
     viewable_type: string;
+    position: number | null;
+    alt: string | null;
     created_at: string;
     updated_at: string;
     original_url: string | null;
@@ -316,6 +401,48 @@ type StoreImage = {
     og_image_url: string | null;
 };
 
+type StoreImportRow = {
+    id: string;
+    row_number: number;
+    status: string;
+    validation_errors: unknown;
+    item_type: string | null;
+    created_at: string;
+    updated_at: string;
+    import_id: string | null;
+    item_id: string | null;
+};
+
+type StoreImport = {
+    id: string;
+    number: string;
+    type: string | null;
+    rows_count: number;
+    created_at: string;
+    updated_at: string;
+    status: string;
+    owner_type: string | null;
+    owner_id: string | null;
+    user_id: string | null;
+};
+
+type StoreInvitation = {
+    id: string;
+    email: string;
+    resource_type: string | null;
+    inviter_type: string | null;
+    invitee_type: string | null;
+    created_at: string;
+    updated_at: string;
+    status: string;
+    resource_id: string | null;
+    inviter_id: string | null;
+    invitee_id: string | null;
+    role_id: string | null;
+    expires_at: string | null;
+    accepted_at: string | null;
+};
+
 type StoreLineItem = {
     id: string;
     variant_id: string;
@@ -362,6 +489,16 @@ type StoreMetafield = {
     value: any;
 };
 
+type StoreNewsletterSubscriber = {
+    id: string;
+    email: string;
+    created_at: string;
+    updated_at: string;
+    verified: boolean;
+    verified_at: string | null;
+    user_id: string | null;
+};
+
 type StoreOptionType = {
     id: string;
     name: string;
@@ -397,6 +534,7 @@ type StoreOrder = {
     email: string | null;
     special_instructions: string | null;
     currency: string;
+    locale: string | null;
     item_count: number;
     shipment_state: string | null;
     payment_state: string | null;
@@ -487,7 +625,6 @@ type StorePaymentSetupSession = {
 type StorePaymentSource = {
     id: string;
     gateway_payment_profile_id: string | null;
-    public_metadata: Record<string, unknown> | null;
 };
 
 type StorePrice = {
@@ -531,6 +668,87 @@ type StoreProduct = {
     metafields?: Array<StoreMetafield>;
 };
 
+type StorePromotion = {
+    id: string;
+    name: string;
+    description: string | null;
+    code: string | null;
+    type: string | null;
+    kind: string | null;
+    path: string | null;
+    match_policy: string | null;
+    usage_limit: number | null;
+    advertise: boolean;
+    multi_codes: boolean;
+    code_prefix: string | null;
+    number_of_codes: number | null;
+    starts_at: string | null;
+    expires_at: string | null;
+    created_at: string;
+    updated_at: string;
+    promotion_category_id: string | null;
+};
+
+type StoreRefund = {
+    id: string;
+    transaction_id: string | null;
+    created_at: string;
+    updated_at: string;
+    amount: string | null;
+    payment_id: string | null;
+    refund_reason_id: string | null;
+    reimbursement_id: string | null;
+};
+
+type StoreReimbursement = {
+    id: string;
+    number: string;
+    reimbursement_status: string | null;
+    created_at: string;
+    updated_at: string;
+    total: string | null;
+    order_id: string | null;
+    customer_return_id: string | null;
+};
+
+type StoreReport = {
+    id: string;
+    type: string | null;
+    currency: string | null;
+    created_at: string;
+    updated_at: string;
+    user_id: string | null;
+    date_from: string | null;
+    date_to: string | null;
+};
+
+type StoreReturnAuthorization = {
+    id: string;
+    number: string;
+    created_at: string;
+    updated_at: string;
+    state: string;
+    order_id: string | null;
+    stock_location_id: string | null;
+    return_authorization_reason_id: string | null;
+};
+
+type StoreReturnItem = {
+    id: string;
+    reception_status: string | null;
+    acceptance_status: string | null;
+    created_at: string;
+    updated_at: string;
+    pre_tax_amount: string | null;
+    included_tax_total: string | null;
+    additional_tax_total: string | null;
+    inventory_unit_id: string | null;
+    return_authorization_id: string | null;
+    customer_return_id: string | null;
+    reimbursement_id: string | null;
+    exchange_variant_id: string | null;
+};
+
 type StoreShipment = {
     id: string;
     number: string;
@@ -568,6 +786,16 @@ type StoreState = {
     name: string;
 };
 
+type StoreStockItem = {
+    id: string;
+    count_on_hand: number;
+    backorderable: boolean;
+    created_at: string;
+    updated_at: string;
+    stock_location_id: string | null;
+    variant_id: string | null;
+};
+
 type StoreStockLocation = {
     id: string;
     state_abbr: string | null;
@@ -580,6 +808,28 @@ type StoreStockLocation = {
     state_text: string | null;
 };
 
+type StoreStockMovement = {
+    id: string;
+    quantity: number;
+    action: string | null;
+    originator_type: string | null;
+    created_at: string;
+    updated_at: string;
+    originator_id: string | null;
+    stock_item_id: string | null;
+};
+
+type StoreStockTransfer = {
+    id: string;
+    number: string | null;
+    type: string | null;
+    reference: string | null;
+    created_at: string;
+    updated_at: string;
+    source_location_id: string | null;
+    destination_location_id: string | null;
+};
+
 type StoreStoreCredit = {
     id: string;
     amount: string;
@@ -598,22 +848,16 @@ type StoreStore = {
     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>;
 };
 
@@ -702,6 +946,11 @@ type StoreWishlist = {
     items?: Array<StoreWishedItem>;
 };
 
+interface LocaleDefaults {
+    locale?: string;
+    currency?: string;
+    country?: string;
+}
 interface PaginationMeta {
     page: number;
     limit: number;
@@ -742,31 +991,67 @@ interface RegisterParams {
 interface ListParams {
     page?: number;
     per_page?: number;
-    includes?: string;
+    /** Associations to include. Accepts array or comma-separated string. */
+    includes?: string[] | string;
 }
 interface ProductListParams extends ListParams {
-    'q[name_cont]'?: string;
-    'q[price_gte]'?: number;
-    'q[price_lte]'?: number;
-    'q[taxons_id_eq]'?: string;
+    /** Sort: 'price asc', 'price desc', 'best_selling', 'name asc', 'name desc', 'available_on desc', 'available_on asc' */
+    sort?: string;
+    /** Full-text search across name and SKU */
+    multi_search?: string;
+    /** Filter: name contains */
+    name_cont?: string;
+    /** Filter: price >= value */
+    price_gte?: number;
+    /** Filter: price <= value */
+    price_lte?: number;
+    /** Filter by option value prefix IDs */
+    with_option_value_ids?: string[];
+    /** Filter: only in-stock products */
+    in_stock?: boolean;
+    /** Filter: only out-of-stock products */
+    out_of_stock?: boolean;
+    /** Filter: products in taxon */
+    taxons_id_eq?: string;
+    /** Any additional Ransack predicate */
+    [key: string]: string | number | boolean | (string | number)[] | undefined;
 }
 interface TaxonListParams extends ListParams {
-    'q[taxonomy_id_eq]'?: string | number;
-    'q[parent_id_eq]'?: string | number;
-    'q[depth_eq]'?: number;
-    'q[name_cont]'?: string;
+    /** Sort order, e.g. 'name asc', 'created_at desc' */
+    sort?: string;
+    /** Filter: name contains */
+    name_cont?: string;
+    taxonomy_id_eq?: string | number;
+    parent_id_eq?: string | number;
+    depth_eq?: number;
+    /** Any additional Ransack predicate */
+    [key: string]: string | number | boolean | (string | number)[] | undefined;
 }
 interface OrderListParams extends ListParams {
-    'q[state_eq]'?: string;
-    'q[completed_at_gte]'?: string;
-    'q[completed_at_lte]'?: string;
+    /** Sort order, e.g. 'completed_at desc' */
+    sort?: string;
+    /** Full-text search across number, email, customer name */
+    multi_search?: string;
+    state_eq?: string;
+    completed_at_gte?: string;
+    completed_at_lte?: string;
+    /** Any additional Ransack predicate */
+    [key: string]: string | number | boolean | (string | number)[] | undefined;
+}
+interface CreateCartParams {
+    /** Arbitrary key-value metadata (stored, not returned in responses) */
+    metadata?: Record<string, unknown>;
 }
 interface AddLineItemParams {
     variant_id: string;
     quantity: number;
+    /** Arbitrary key-value metadata (stored, not returned in responses) */
+    metadata?: Record<string, unknown>;
 }
 interface UpdateLineItemParams {
-    quantity: number;
+    quantity?: number;
+    /** Arbitrary key-value metadata (merged with existing) */
+    metadata?: Record<string, unknown>;
 }
 interface AddressParams {
     firstname: string;
@@ -787,7 +1072,10 @@ interface AddressParams {
 interface UpdateOrderParams {
     email?: string;
     currency?: string;
+    locale?: string;
     special_instructions?: string;
+    /** Arbitrary key-value metadata (merged with existing) */
+    metadata?: Record<string, unknown>;
     /** Existing address ID to use */
     bill_address_id?: string;
     /** Existing address ID to use */
@@ -819,20 +1107,22 @@ interface CompletePaymentSetupSessionParams {
 }
 interface FilterOption {
     id: string;
-    label: string;
     count: number;
 }
 interface OptionFilterOption extends FilterOption {
     name: string;
+    presentation: string;
     position: number;
 }
-interface TaxonFilterOption extends FilterOption {
+interface TaxonFilterOption {
+    id: string;
+    name: string;
     permalink: string;
+    count: number;
 }
 interface PriceRangeFilter {
     id: 'price';
     type: 'price_range';
-    label: string;
     min: number;
     max: number;
     currency: string;
@@ -840,26 +1130,23 @@ interface PriceRangeFilter {
 interface AvailabilityFilter {
     id: 'availability';
     type: 'availability';
-    label: string;
     options: FilterOption[];
 }
 interface OptionFilter {
     id: string;
     type: 'option';
-    label: string;
     name: string;
+    presentation: 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[];
@@ -872,4 +1159,4 @@ interface ProductFiltersParams {
     q?: Record<string, unknown>;
 }
 
-export type { AddLineItemParams, AddressParams, AdminCustomer, AdminMetafield, AdminOrder, AdminPrice, AdminProduct, AdminTaxon, AdminTaxonomy, AdminVariant, AuthTokens, AvailabilityFilter, CompletePaymentSessionParams, CompletePaymentSetupSessionParams, CreatePaymentSessionParams, CreatePaymentSetupSessionParams, ErrorResponse, FilterOption, ListParams, LoginCredentials, OptionFilter, OptionFilterOption, OrderListParams, PaginatedResponse, PaginationMeta, PriceRangeFilter, ProductFilter, ProductFiltersParams, ProductFiltersResponse, ProductListParams, RegisterParams, SortOption, StoreAddress, StoreBase, StoreCountry, StoreCreditCard, StoreCurrency, StoreCustomer, StoreDigitalLink, StoreGiftCard, StoreImage, StoreLineItem, StoreLocale, StoreMetafield, StoreOptionType, StoreOptionValue, StoreOrder, StoreOrderPromotion, StorePayment, StorePaymentMethod, StorePaymentSession, StorePaymentSetupSession, StorePaymentSource, StorePrice, StoreProduct, StoreShipment, StoreShippingMethod, StoreShippingRate, StoreState, StoreStockLocation, StoreStore, StoreStoreCredit, StoreTaxon, StoreTaxonomy, StoreVariant, StoreWishedItem, StoreWishlist, TaxonFilter, TaxonFilterOption, TaxonListParams, UpdateLineItemParams, UpdateOrderParams, UpdatePaymentSessionParams };
+export type { AddLineItemParams, AddressParams, AdminCustomer, AdminLineItem, AdminMetafield, AdminOrder, AdminPrice, AdminProduct, AdminTaxon, AdminTaxonomy, AdminVariant, AuthTokens, AvailabilityFilter, CompletePaymentSessionParams, CompletePaymentSetupSessionParams, CreateCartParams, CreatePaymentSessionParams, CreatePaymentSetupSessionParams, ErrorResponse, FilterOption, ListParams, LocaleDefaults, LoginCredentials, OptionFilter, OptionFilterOption, OrderListParams, PaginatedResponse, PaginationMeta, PriceRangeFilter, ProductFilter, ProductFiltersParams, ProductFiltersResponse, ProductListParams, RegisterParams, SortOption, StoreAddress, StoreAsset, StoreBase, StoreCountry, StoreCreditCard, StoreCurrency, StoreCustomer, StoreCustomerReturn, StoreDigital, StoreDigitalLink, StoreExport, StoreGiftCard, StoreGiftCardBatch, StoreImage, StoreImport, StoreImportRow, StoreInvitation, StoreLineItem, StoreLocale, StoreMetafield, StoreNewsletterSubscriber, StoreOptionType, StoreOptionValue, StoreOrder, StoreOrderPromotion, StorePayment, StorePaymentMethod, StorePaymentSession, StorePaymentSetupSession, StorePaymentSource, StorePrice, StoreProduct, StorePromotion, StoreRefund, StoreReimbursement, StoreReport, StoreReturnAuthorization, StoreReturnItem, StoreShipment, StoreShippingMethod, StoreShippingRate, StoreState, StoreStockItem, StoreStockLocation, StoreStockMovement, StoreStockTransfer, StoreStore, StoreStoreCredit, StoreTaxon, StoreTaxonomy, StoreVariant, StoreWishedItem, StoreWishlist, TaxonFilter, TaxonFilterOption, TaxonListParams, UpdateLineItemParams, UpdateOrderParams, UpdatePaymentSessionParams };