@spree/sdk 0.4.0 → 0.6.0

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;
 };
@@ -231,6 +278,9 @@ type StoreCountry = {
     name: string;
     states_required: boolean;
     zipcode_required: boolean;
+    currency: string | null;
+    default_locale: string | null;
+    supported_locales: Array<string>;
     states?: Array<StoreState>;
 };
 
@@ -245,6 +295,20 @@ type StoreCreditCard = {
     gateway_payment_profile_id: string | null;
 };
 
+type StoreCurrency = {
+    iso_code: string;
+    name: string;
+    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;
@@ -270,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;
@@ -293,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;
@@ -307,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;
@@ -340,15 +476,9 @@ type StoreLineItem = {
     digital_links: Array<StoreDigitalLink>;
 };
 
-type StoreMarket = {
-    id: string;
+type StoreLocale = {
+    code: string;
     name: string;
-    currency: string;
-    default_locale: string;
-    tax_inclusive: boolean;
-    default: boolean;
-    supported_locales: Array<string>;
-    countries: Array<StoreCountry>;
 };
 
 type StoreMetafield = {
@@ -359,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;
@@ -394,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;
@@ -484,7 +625,27 @@ type StorePaymentSetupSession = {
 type StorePaymentSource = {
     id: string;
     gateway_payment_profile_id: string | null;
-    public_metadata: Record<string, unknown> | null;
+};
+
+type StorePostCategory = {
+    id: string;
+    title: string;
+    slug: string;
+    created_at: string;
+    updated_at: string;
+};
+
+type StorePost = {
+    id: string;
+    title: string;
+    slug: string;
+    meta_title: string | null;
+    meta_description: string | null;
+    published_at: string | null;
+    created_at: string;
+    updated_at: string;
+    author_id: string | null;
+    post_category_id: string | null;
 };
 
 type StorePrice = {
@@ -528,6 +689,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;
@@ -565,6 +807,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;
@@ -577,6 +829,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;
@@ -595,22 +869,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>;
 };
 
@@ -758,12 +1026,20 @@ interface OrderListParams extends ListParams {
     'q[completed_at_gte]'?: string;
     'q[completed_at_lte]'?: string;
 }
+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;
@@ -784,7 +1060,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 */
@@ -869,4 +1148,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, StoreCustomer, StoreDigitalLink, StoreGiftCard, StoreImage, StoreLineItem, StoreMarket, 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, 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, StorePost, StorePostCategory, 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 };