@aimee.shop/sdk 0.17.0 → 0.18.0-dev.121
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/events/event-names.d.ts +142 -146
- package/dist/core/events/event-names.d.ts.map +1 -1
- package/dist/core/events/event-names.js +141 -145
- package/dist/core/events/event-names.js.map +1 -1
- package/dist/index.d.ts +17 -17
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/services/core/assets.client.d.ts +2 -8
- package/dist/services/core/assets.client.d.ts.map +1 -1
- package/dist/services/core/assets.client.js.map +1 -1
- package/dist/services/core/base-resource.d.ts +7 -2
- package/dist/services/core/base-resource.d.ts.map +1 -1
- package/dist/services/core/base-resource.js +27 -20
- package/dist/services/core/base-resource.js.map +1 -1
- package/dist/services/core/cart-messages/cart-messages.client.d.ts +14 -4
- package/dist/services/core/cart-messages/cart-messages.client.d.ts.map +1 -1
- package/dist/services/core/cart-messages/cart-messages.client.js +37 -4
- package/dist/services/core/cart-messages/cart-messages.client.js.map +1 -1
- package/dist/services/core/cart-messages/index.d.ts +1 -1
- package/dist/services/core/cart-messages/index.d.ts.map +1 -1
- package/dist/services/core/cart-messages/types.d.ts +19 -2
- package/dist/services/core/cart-messages/types.d.ts.map +1 -1
- package/dist/services/core/carts.client.d.ts +46 -8
- package/dist/services/core/carts.client.d.ts.map +1 -1
- package/dist/services/core/carts.client.js +18 -0
- package/dist/services/core/carts.client.js.map +1 -1
- package/dist/services/core/categories.client.d.ts +14 -7
- package/dist/services/core/categories.client.d.ts.map +1 -1
- package/dist/services/core/categories.client.js.map +1 -1
- package/dist/services/core/checkout.client.d.ts +74 -35
- package/dist/services/core/checkout.client.d.ts.map +1 -1
- package/dist/services/core/checkout.client.js +3 -2
- package/dist/services/core/checkout.client.js.map +1 -1
- package/dist/services/core/cms/cms.client.d.ts +1 -1
- package/dist/services/core/cms/cms.client.js +1 -1
- package/dist/services/core/cms/entries.client.d.ts +4 -2
- package/dist/services/core/cms/entries.client.d.ts.map +1 -1
- package/dist/services/core/cms/entries.client.js +8 -2
- package/dist/services/core/cms/entries.client.js.map +1 -1
- package/dist/services/core/cms/types.d.ts +95 -53
- package/dist/services/core/cms/types.d.ts.map +1 -1
- package/dist/services/core/cms/types.js.map +1 -1
- package/dist/services/core/customers.client.d.ts +70 -61
- package/dist/services/core/customers.client.d.ts.map +1 -1
- package/dist/services/core/customers.client.js +15 -13
- package/dist/services/core/customers.client.js.map +1 -1
- package/dist/services/core/discounts.client.d.ts +98 -46
- package/dist/services/core/discounts.client.d.ts.map +1 -1
- package/dist/services/core/discounts.client.js +17 -17
- package/dist/services/core/discounts.client.js.map +1 -1
- package/dist/services/core/facets.client.d.ts +27 -10
- package/dist/services/core/facets.client.d.ts.map +1 -1
- package/dist/services/core/facets.client.js +18 -7
- package/dist/services/core/facets.client.js.map +1 -1
- package/dist/services/core/fulfillments.client.d.ts +51 -27
- package/dist/services/core/fulfillments.client.d.ts.map +1 -1
- package/dist/services/core/fulfillments.client.js +30 -18
- package/dist/services/core/fulfillments.client.js.map +1 -1
- package/dist/services/core/inventory/adjustments.client.d.ts +12 -2
- package/dist/services/core/inventory/adjustments.client.d.ts.map +1 -1
- package/dist/services/core/inventory/adjustments.client.js.map +1 -1
- package/dist/services/core/inventory/index.d.ts +1 -1
- package/dist/services/core/inventory/index.d.ts.map +1 -1
- package/dist/services/core/inventory/reservations.client.d.ts +3 -3
- package/dist/services/core/inventory/reservations.client.d.ts.map +1 -1
- package/dist/services/core/inventory/reservations.client.js +2 -2
- package/dist/services/core/inventory/reservations.client.js.map +1 -1
- package/dist/services/core/inventory/types.d.ts +29 -6
- package/dist/services/core/inventory/types.d.ts.map +1 -1
- package/dist/services/core/inventory/types.js +1 -0
- package/dist/services/core/inventory/types.js.map +1 -1
- package/dist/services/core/invoices.client.d.ts +4 -7
- package/dist/services/core/invoices.client.d.ts.map +1 -1
- package/dist/services/core/invoices.client.js +1 -1
- package/dist/services/core/invoices.client.js.map +1 -1
- package/dist/services/core/openai-feed.client.d.ts +34 -3
- package/dist/services/core/openai-feed.client.d.ts.map +1 -1
- package/dist/services/core/openai-feed.client.js.map +1 -1
- package/dist/services/core/option-types.client.d.ts +6 -7
- package/dist/services/core/option-types.client.d.ts.map +1 -1
- package/dist/services/core/option-types.client.js +7 -8
- package/dist/services/core/option-types.client.js.map +1 -1
- package/dist/services/core/option-values.client.d.ts +2 -1
- package/dist/services/core/option-values.client.d.ts.map +1 -1
- package/dist/services/core/option-values.client.js +2 -1
- package/dist/services/core/option-values.client.js.map +1 -1
- package/dist/services/core/order-edits.client.d.ts +20 -14
- package/dist/services/core/order-edits.client.d.ts.map +1 -1
- package/dist/services/core/order-edits.client.js +1 -1
- package/dist/services/core/order-edits.client.js.map +1 -1
- package/dist/services/core/orders.client.d.ts +139 -49
- package/dist/services/core/orders.client.d.ts.map +1 -1
- package/dist/services/core/orders.client.js +40 -9
- package/dist/services/core/orders.client.js.map +1 -1
- package/dist/services/core/pricing/currencies.client.d.ts +9 -23
- package/dist/services/core/pricing/currencies.client.d.ts.map +1 -1
- package/dist/services/core/pricing/currencies.client.js +12 -30
- package/dist/services/core/pricing/currencies.client.js.map +1 -1
- package/dist/services/core/pricing/pricing.client.d.ts +5 -5
- package/dist/services/core/pricing/pricing.client.d.ts.map +1 -1
- package/dist/services/core/pricing/pricing.client.js +4 -4
- package/dist/services/core/pricing/pricing.client.js.map +1 -1
- package/dist/services/core/pricing/store-markets.client.d.ts +2 -5
- package/dist/services/core/pricing/store-markets.client.d.ts.map +1 -1
- package/dist/services/core/pricing/store-markets.client.js +1 -7
- package/dist/services/core/pricing/store-markets.client.js.map +1 -1
- package/dist/services/core/pricing/tiers.client.d.ts +4 -4
- package/dist/services/core/pricing/tiers.client.js +4 -4
- package/dist/services/core/pricing/types.d.ts +67 -60
- package/dist/services/core/pricing/types.d.ts.map +1 -1
- package/dist/services/core/pricing/variant-prices.client.d.ts +14 -14
- package/dist/services/core/pricing/variant-prices.client.d.ts.map +1 -1
- package/dist/services/core/pricing/variant-prices.client.js +14 -18
- package/dist/services/core/pricing/variant-prices.client.js.map +1 -1
- package/dist/services/core/products.client.d.ts +73 -13
- package/dist/services/core/products.client.d.ts.map +1 -1
- package/dist/services/core/products.client.js.map +1 -1
- package/dist/services/core/returns.client.d.ts +21 -6
- package/dist/services/core/returns.client.d.ts.map +1 -1
- package/dist/services/core/returns.client.js +12 -6
- package/dist/services/core/returns.client.js.map +1 -1
- package/dist/services/core/reviews.client.d.ts +17 -15
- package/dist/services/core/reviews.client.d.ts.map +1 -1
- package/dist/services/core/reviews.client.js.map +1 -1
- package/dist/services/core/search.client.d.ts +26 -11
- package/dist/services/core/search.client.d.ts.map +1 -1
- package/dist/services/core/search.client.js.map +1 -1
- package/dist/services/core/shipping/classes.client.d.ts +2 -5
- package/dist/services/core/shipping/classes.client.d.ts.map +1 -1
- package/dist/services/core/shipping/classes.client.js +4 -0
- package/dist/services/core/shipping/classes.client.js.map +1 -1
- package/dist/services/core/shipping/labels.client.d.ts +3 -6
- package/dist/services/core/shipping/labels.client.d.ts.map +1 -1
- package/dist/services/core/shipping/labels.client.js +5 -1
- package/dist/services/core/shipping/labels.client.js.map +1 -1
- package/dist/services/core/shipping/providers.client.d.ts +2 -5
- package/dist/services/core/shipping/providers.client.d.ts.map +1 -1
- package/dist/services/core/shipping/providers.client.js +6 -2
- package/dist/services/core/shipping/providers.client.js.map +1 -1
- package/dist/services/core/shipping/rules.client.d.ts +2 -5
- package/dist/services/core/shipping/rules.client.d.ts.map +1 -1
- package/dist/services/core/shipping/rules.client.js +4 -2
- package/dist/services/core/shipping/rules.client.js.map +1 -1
- package/dist/services/core/shipping/shipping.client.d.ts +4 -4
- package/dist/services/core/shipping/shipping.client.d.ts.map +1 -1
- package/dist/services/core/shipping/shipping.client.js +7 -5
- package/dist/services/core/shipping/shipping.client.js.map +1 -1
- package/dist/services/core/shipping/store-providers.client.d.ts +5 -5
- package/dist/services/core/shipping/store-providers.client.d.ts.map +1 -1
- package/dist/services/core/shipping/store-providers.client.js +1 -1
- package/dist/services/core/shipping/store-providers.client.js.map +1 -1
- package/dist/services/core/shipping/types.d.ts +196 -67
- package/dist/services/core/shipping/types.d.ts.map +1 -1
- package/dist/services/core/shipping/zones.client.d.ts +2 -5
- package/dist/services/core/shipping/zones.client.d.ts.map +1 -1
- package/dist/services/core/shipping/zones.client.js +4 -0
- package/dist/services/core/shipping/zones.client.js.map +1 -1
- package/dist/services/core/storefront/index.d.ts +1 -1
- package/dist/services/core/storefront/index.d.ts.map +1 -1
- package/dist/services/core/storefront/index.js.map +1 -1
- package/dist/services/core/storefront/storefront-auth.client.d.ts +9 -4
- package/dist/services/core/storefront/storefront-auth.client.d.ts.map +1 -1
- package/dist/services/core/storefront/storefront-auth.client.js +7 -2
- package/dist/services/core/storefront/storefront-auth.client.js.map +1 -1
- package/dist/services/core/storefront/storefront-plans.client.d.ts +5 -4
- package/dist/services/core/storefront/storefront-plans.client.d.ts.map +1 -1
- package/dist/services/core/storefront/storefront-plans.client.js.map +1 -1
- package/dist/services/core/storefront/storefront-subscriptions.client.d.ts +19 -12
- package/dist/services/core/storefront/storefront-subscriptions.client.d.ts.map +1 -1
- package/dist/services/core/storefront/storefront-subscriptions.client.js.map +1 -1
- package/dist/services/core/storefront/storefront.client.d.ts +4 -1
- package/dist/services/core/storefront/storefront.client.d.ts.map +1 -1
- package/dist/services/core/storefront/storefront.client.js +4 -1
- package/dist/services/core/storefront/storefront.client.js.map +1 -1
- package/dist/services/core/storefront/types.d.ts +10 -0
- package/dist/services/core/storefront/types.d.ts.map +1 -1
- package/dist/services/core/stores/configuration.client.d.ts +21 -18
- package/dist/services/core/stores/configuration.client.d.ts.map +1 -1
- package/dist/services/core/stores/configuration.client.js.map +1 -1
- package/dist/services/core/stores/index.d.ts +1 -1
- package/dist/services/core/stores/index.d.ts.map +1 -1
- package/dist/services/core/stores/index.js.map +1 -1
- package/dist/services/core/stores/stores.client.d.ts +44 -15
- package/dist/services/core/stores/stores.client.d.ts.map +1 -1
- package/dist/services/core/stores/stores.client.js +10 -5
- package/dist/services/core/stores/stores.client.js.map +1 -1
- package/dist/services/core/taxes/jurisdictions.client.d.ts +4 -4
- package/dist/services/core/taxes/jurisdictions.client.d.ts.map +1 -1
- package/dist/services/core/taxes/jurisdictions.client.js +7 -4
- package/dist/services/core/taxes/jurisdictions.client.js.map +1 -1
- package/dist/services/core/taxes/providers.client.d.ts +1 -1
- package/dist/services/core/taxes/providers.client.d.ts.map +1 -1
- package/dist/services/core/taxes/providers.client.js.map +1 -1
- package/dist/services/core/taxes/rates.client.d.ts +2 -1
- package/dist/services/core/taxes/rates.client.d.ts.map +1 -1
- package/dist/services/core/taxes/rates.client.js +2 -1
- package/dist/services/core/taxes/rates.client.js.map +1 -1
- package/dist/services/core/taxes/store-providers.client.d.ts +5 -5
- package/dist/services/core/taxes/store-providers.client.d.ts.map +1 -1
- package/dist/services/core/taxes/store-providers.client.js +1 -1
- package/dist/services/core/taxes/store-providers.client.js.map +1 -1
- package/dist/services/core/taxes/taxes.client.d.ts +6 -3
- package/dist/services/core/taxes/taxes.client.d.ts.map +1 -1
- package/dist/services/core/taxes/taxes.client.js +5 -2
- package/dist/services/core/taxes/taxes.client.js.map +1 -1
- package/dist/services/core/taxes/types.d.ts +251 -128
- package/dist/services/core/taxes/types.d.ts.map +1 -1
- package/dist/services/core/variants.client.d.ts +80 -11
- package/dist/services/core/variants.client.d.ts.map +1 -1
- package/dist/services/core/variants.client.js +2 -2
- package/dist/services/core/variants.client.js.map +1 -1
- package/dist/services/core/wishlists.client.d.ts +31 -25
- package/dist/services/core/wishlists.client.d.ts.map +1 -1
- package/dist/services/core/wishlists.client.js +4 -2
- package/dist/services/core/wishlists.client.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,13 +1,24 @@
|
|
|
1
1
|
import type { HttpClientTransport as HttpClient } from '../../core/http-client.js';
|
|
2
2
|
import type { AddressSnapshot } from '../../core/types/address.js';
|
|
3
|
-
import type {
|
|
4
|
-
import { BaseResourceClient } from './base-resource.js';
|
|
3
|
+
import type { ListOptions } from '../../core/types/pagination.js';
|
|
5
4
|
import { OrderEditsClient } from './order-edits.client.js';
|
|
6
5
|
import { FulfillmentsClient } from './fulfillments.client.js';
|
|
7
6
|
import { InvoicesClient } from './invoices.client.js';
|
|
8
7
|
export type OrderStatus = 'pending' | 'confirmed' | 'processing' | 'partially_shipped' | 'shipped' | 'delivered' | 'completed' | 'cancelled' | 'refunded';
|
|
9
8
|
export type OrderWorkflowState = 'created' | 'paymentPending' | 'paymentConfirmed' | 'inventoryAllocated' | 'fulfillmentPending' | 'fulfillmentProcessing' | 'shipped' | 'delivered' | 'cancelled' | 'refunded' | 'completed';
|
|
10
|
-
export type OrderSource = 'checkout' | '
|
|
9
|
+
export type OrderSource = 'checkout' | 'api' | 'admin' | 'erp' | 'subscription';
|
|
10
|
+
export type OrderPaymentStatus = 'pending' | 'authorized' | 'captured' | 'failed' | 'refunded' | 'partially_refunded';
|
|
11
|
+
export type OrderFulfillmentStatus = 'unfulfilled' | 'processing' | 'partially_shipped' | 'shipped' | 'partially_delivered' | 'delivered';
|
|
12
|
+
/** Per-fulfillment carrier summary derived from the order's fulfillments. */
|
|
13
|
+
export interface OrderCarrierInformation {
|
|
14
|
+
carrier?: string;
|
|
15
|
+
serviceLevel?: string;
|
|
16
|
+
trackingNumber?: string;
|
|
17
|
+
trackingUrl?: string;
|
|
18
|
+
status: string;
|
|
19
|
+
shippedAt?: string;
|
|
20
|
+
deliveredAt?: string;
|
|
21
|
+
}
|
|
11
22
|
export interface OrderStatusHistoryEntry {
|
|
12
23
|
previousStatus?: OrderStatus;
|
|
13
24
|
newStatus: OrderStatus;
|
|
@@ -20,23 +31,43 @@ export interface OrderStatusHistoryEntry {
|
|
|
20
31
|
}
|
|
21
32
|
export interface Order {
|
|
22
33
|
id: string;
|
|
34
|
+
tenantId: string;
|
|
35
|
+
storeId: string;
|
|
23
36
|
customerId: string;
|
|
24
37
|
organizationId?: string;
|
|
38
|
+
email?: string | null;
|
|
25
39
|
purchaseOrderNumber?: string;
|
|
40
|
+
orderNumber: string;
|
|
26
41
|
status: OrderStatus;
|
|
27
42
|
workflowState: OrderWorkflowState;
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
43
|
+
/** Cents, serialized from BigInt */
|
|
44
|
+
totalAmount: string;
|
|
45
|
+
/** Cents, serialized from BigInt */
|
|
46
|
+
subtotalAmount: string;
|
|
47
|
+
/** Cents, serialized from BigInt */
|
|
48
|
+
taxAmount: string;
|
|
49
|
+
/** Cents, serialized from BigInt */
|
|
50
|
+
shippingAmount: string;
|
|
51
|
+
/** Cents, serialized from BigInt */
|
|
52
|
+
discountAmount: string;
|
|
33
53
|
orderItems: OrderItem[];
|
|
54
|
+
paymentId?: string | null;
|
|
34
55
|
paymentIntentId?: string;
|
|
56
|
+
paymentMethodId?: string | null;
|
|
35
57
|
paymentStatus?: string;
|
|
58
|
+
paymentCapturedAt?: string | null;
|
|
59
|
+
paymentCurrency?: string | null;
|
|
60
|
+
refundStatus?: string | null;
|
|
36
61
|
fulfillmentStatus?: string;
|
|
62
|
+
/** Derived from fulfillments; present only when the order has tracked fulfillments. */
|
|
37
63
|
trackingNumbers?: string[];
|
|
64
|
+
/** Derived from fulfillments; present only when the order has fulfillments. */
|
|
65
|
+
carrierInformation?: OrderCarrierInformation[];
|
|
38
66
|
estimatedDeliveryDate?: string;
|
|
67
|
+
actualDeliveryDate?: string | null;
|
|
39
68
|
erpOrderId?: string;
|
|
69
|
+
checkoutSessionId?: string | null;
|
|
70
|
+
cartId?: string | null;
|
|
40
71
|
shippingAddress?: AddressSnapshot;
|
|
41
72
|
billingAddress?: AddressSnapshot;
|
|
42
73
|
shippingMethod?: string;
|
|
@@ -64,44 +95,43 @@ export interface Order {
|
|
|
64
95
|
exchangeRatesAt?: string | null;
|
|
65
96
|
metadata?: Record<string, unknown>;
|
|
66
97
|
version: number;
|
|
67
|
-
|
|
98
|
+
/** Present on list responses only. */
|
|
68
99
|
returnsCount?: number;
|
|
69
|
-
|
|
100
|
+
/** Declared in the API schema but not populated by order responses; use getTimeline(). */
|
|
101
|
+
statusHistory?: OrderStatusHistoryEntry[];
|
|
70
102
|
allowedTransitions?: string[];
|
|
71
103
|
allowedActions?: string[];
|
|
72
104
|
subscriptionId?: string;
|
|
73
105
|
source?: OrderSource;
|
|
74
|
-
orderNumber?: string;
|
|
75
106
|
createdAt: string;
|
|
76
107
|
updatedAt: string;
|
|
77
108
|
}
|
|
78
109
|
export interface OrderItem {
|
|
79
110
|
id: string;
|
|
111
|
+
orderId: string;
|
|
80
112
|
productId: string;
|
|
81
113
|
productVariantId?: string;
|
|
82
114
|
productName: string;
|
|
83
115
|
productSku?: string;
|
|
84
|
-
|
|
116
|
+
productSlug?: string | null;
|
|
117
|
+
/** Cents, serialized from BigInt */
|
|
118
|
+
unitPrice: string;
|
|
85
119
|
quantity: number;
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
120
|
+
/** Cents, serialized from BigInt */
|
|
121
|
+
totalPrice: string;
|
|
122
|
+
/** Cents, serialized from BigInt */
|
|
123
|
+
discountAmount: string;
|
|
124
|
+
/** Cents, serialized from BigInt */
|
|
125
|
+
taxAmount: string;
|
|
89
126
|
fulfillmentStatus: string;
|
|
90
|
-
|
|
91
|
-
|
|
127
|
+
/** Decimal serialized as a string. */
|
|
128
|
+
weight?: string | null;
|
|
129
|
+
weightUnit?: string | null;
|
|
130
|
+
metadata?: Record<string, unknown>;
|
|
131
|
+
productMetadata?: Record<string, unknown>;
|
|
92
132
|
createdAt: string;
|
|
93
133
|
updatedAt: string;
|
|
94
134
|
}
|
|
95
|
-
export interface CreateOrderDto {
|
|
96
|
-
customerId: string;
|
|
97
|
-
items: {
|
|
98
|
-
productId: string;
|
|
99
|
-
variantId?: string;
|
|
100
|
-
quantity: number;
|
|
101
|
-
}[];
|
|
102
|
-
shippingMethodId?: string;
|
|
103
|
-
discountCodes?: string[];
|
|
104
|
-
}
|
|
105
135
|
export interface UpdateOrderDto {
|
|
106
136
|
organizationId?: string;
|
|
107
137
|
purchaseOrderNumber?: string;
|
|
@@ -110,11 +140,9 @@ export interface UpdateOrderDto {
|
|
|
110
140
|
workflowState?: OrderWorkflowState;
|
|
111
141
|
statusChangeReason?: string;
|
|
112
142
|
changedBy?: string;
|
|
113
|
-
trackingNumbers?: string[];
|
|
114
|
-
fulfillmentLocations?: string[];
|
|
115
143
|
erpOrderId?: string;
|
|
116
|
-
paymentStatus?:
|
|
117
|
-
fulfillmentStatus?:
|
|
144
|
+
paymentStatus?: OrderPaymentStatus;
|
|
145
|
+
fulfillmentStatus?: OrderFulfillmentStatus;
|
|
118
146
|
estimatedDeliveryDate?: string;
|
|
119
147
|
shippingAddress?: AddressSnapshot;
|
|
120
148
|
billingAddress?: AddressSnapshot;
|
|
@@ -123,10 +151,12 @@ export interface UpdateOrderDto {
|
|
|
123
151
|
export interface OrderFilters extends Record<string, unknown> {
|
|
124
152
|
status?: OrderStatus;
|
|
125
153
|
workflowState?: OrderWorkflowState;
|
|
126
|
-
paymentStatus?:
|
|
127
|
-
fulfillmentStatus?:
|
|
154
|
+
paymentStatus?: OrderPaymentStatus;
|
|
155
|
+
fulfillmentStatus?: OrderFulfillmentStatus;
|
|
128
156
|
customerId?: string;
|
|
157
|
+
/** Minimum order total in integer cents */
|
|
129
158
|
totalMin?: number;
|
|
159
|
+
/** Maximum order total in integer cents */
|
|
130
160
|
totalMax?: number;
|
|
131
161
|
erpOrderId?: string;
|
|
132
162
|
/** Filter orders created after this date (ISO 8601 format) */
|
|
@@ -138,7 +168,7 @@ export interface OrderTransitionDto {
|
|
|
138
168
|
newStatus: OrderStatus;
|
|
139
169
|
newWorkflowState?: OrderWorkflowState;
|
|
140
170
|
reason?: string;
|
|
141
|
-
metadata?: Record<string,
|
|
171
|
+
metadata?: Record<string, string | number | boolean>;
|
|
142
172
|
}
|
|
143
173
|
export type NoteVisibility = 'internal' | 'customer';
|
|
144
174
|
export interface OrderNote {
|
|
@@ -158,25 +188,63 @@ export interface AddOrderNoteDto {
|
|
|
158
188
|
export interface OrderTimeline {
|
|
159
189
|
events: OrderTimelineEvent[];
|
|
160
190
|
}
|
|
191
|
+
export type OrderTimelineEventType = 'status_change' | 'modification' | 'payment' | 'shipping' | 'note';
|
|
161
192
|
export interface OrderTimelineEvent {
|
|
162
193
|
id: string;
|
|
163
|
-
type:
|
|
194
|
+
type: OrderTimelineEventType;
|
|
164
195
|
description: string;
|
|
165
196
|
createdAt: string;
|
|
166
197
|
createdBy?: string;
|
|
198
|
+
metadata?: Record<string, unknown>;
|
|
199
|
+
}
|
|
200
|
+
/** Response of GET /v1/orders (orders use `pagination`, not `meta`). */
|
|
201
|
+
export interface OrderListResponse {
|
|
202
|
+
data: Order[];
|
|
203
|
+
pagination: {
|
|
204
|
+
page: number;
|
|
205
|
+
limit: number;
|
|
206
|
+
total: number;
|
|
207
|
+
pages: number;
|
|
208
|
+
};
|
|
209
|
+
}
|
|
210
|
+
/** Cancelling never issues a refund; refund through returns. */
|
|
211
|
+
export interface CancelOrderDto {
|
|
212
|
+
reason: string;
|
|
213
|
+
}
|
|
214
|
+
export interface ShipOrderDto {
|
|
215
|
+
/** At least one tracking number is required. */
|
|
216
|
+
trackingNumbers: string[];
|
|
217
|
+
carrierInformation?: Record<string, string | number>;
|
|
218
|
+
estimatedDeliveryDate?: string;
|
|
219
|
+
}
|
|
220
|
+
export interface DeliverOrderDto {
|
|
221
|
+
/** Defaults to now. */
|
|
222
|
+
actualDeliveryDate?: string;
|
|
223
|
+
deliveryNotes?: string;
|
|
167
224
|
}
|
|
168
225
|
export interface UpdateFulfillmentDto {
|
|
169
|
-
fulfillmentStatus: 'pending' | '
|
|
226
|
+
fulfillmentStatus: 'pending' | 'shipped' | 'delivered' | 'cancelled';
|
|
170
227
|
trackingNumbers?: string[];
|
|
171
|
-
carrierInformation?: Record<string,
|
|
228
|
+
carrierInformation?: Record<string, string | number>;
|
|
172
229
|
estimatedDeliveryDate?: string;
|
|
173
|
-
fulfillmentLocations?: string[];
|
|
174
230
|
erpOrderId?: string;
|
|
175
231
|
}
|
|
176
232
|
export interface ForceOrderStatusDto {
|
|
177
233
|
status: OrderStatus;
|
|
178
234
|
reason: string;
|
|
179
235
|
}
|
|
236
|
+
export interface ErpFulfillmentSyncItem {
|
|
237
|
+
orderItemId: string;
|
|
238
|
+
quantity: number;
|
|
239
|
+
}
|
|
240
|
+
export interface ErpFulfillmentSync {
|
|
241
|
+
erpFulfillmentId: string;
|
|
242
|
+
items: ErpFulfillmentSyncItem[];
|
|
243
|
+
trackingNumber?: string;
|
|
244
|
+
carrier?: string;
|
|
245
|
+
shippedAt?: string;
|
|
246
|
+
locationId?: string;
|
|
247
|
+
}
|
|
180
248
|
export interface ErpOrderProviderIds {
|
|
181
249
|
internalId?: string;
|
|
182
250
|
externalId?: string;
|
|
@@ -201,6 +269,7 @@ export interface ErpOrderSyncDto {
|
|
|
201
269
|
status?: string;
|
|
202
270
|
trackingNumbers?: string[];
|
|
203
271
|
estimatedDeliveryDate?: string;
|
|
272
|
+
fulfillments?: ErpFulfillmentSync[];
|
|
204
273
|
lastModified?: string;
|
|
205
274
|
customerInternalId?: string;
|
|
206
275
|
tranDate?: string;
|
|
@@ -210,12 +279,36 @@ export interface ErpOrderSyncDto {
|
|
|
210
279
|
export interface ErpOrderSyncResponse {
|
|
211
280
|
orderId: string;
|
|
212
281
|
action: 'updated' | 'noop';
|
|
282
|
+
fulfillments?: Array<{
|
|
283
|
+
erpFulfillmentId: string;
|
|
284
|
+
fulfillmentId: string;
|
|
285
|
+
result: 'created' | 'replayed' | 'updated';
|
|
286
|
+
}>;
|
|
213
287
|
}
|
|
214
|
-
|
|
288
|
+
/**
|
|
289
|
+
* Orders are created only through checkout (`sdk.checkout.adminCreate` for admin-entered
|
|
290
|
+
* orders), so there is no `create`.
|
|
291
|
+
*/
|
|
292
|
+
export declare class OrdersClient {
|
|
293
|
+
private readonly http;
|
|
294
|
+
private readonly baseUrl;
|
|
215
295
|
private _edits?;
|
|
216
296
|
private _fulfillments?;
|
|
217
297
|
private _invoices?;
|
|
218
|
-
constructor(
|
|
298
|
+
constructor(http: HttpClient, baseUrl: string);
|
|
299
|
+
private get endpoint();
|
|
300
|
+
/**
|
|
301
|
+
* Get a single order by ID
|
|
302
|
+
*/
|
|
303
|
+
get(id: string): Promise<Order>;
|
|
304
|
+
/**
|
|
305
|
+
* List orders with optional pagination and filters
|
|
306
|
+
*/
|
|
307
|
+
list(options?: ListOptions<OrderFilters>): Promise<OrderListResponse>;
|
|
308
|
+
/**
|
|
309
|
+
* Delete an order by ID
|
|
310
|
+
*/
|
|
311
|
+
delete(id: string): Promise<void>;
|
|
219
312
|
/**
|
|
220
313
|
* Sub-client for order edit sessions (two-phase line item editing).
|
|
221
314
|
*
|
|
@@ -233,7 +326,7 @@ export declare class OrdersClient extends BaseResourceClient<Order, CreateOrderD
|
|
|
233
326
|
* @example
|
|
234
327
|
* ```typescript
|
|
235
328
|
* const fulfillment = await sdk.orders.fulfillments.create(orderId, {
|
|
236
|
-
* items: [{ orderItemId: 'item-uuid',
|
|
329
|
+
* items: [{ orderItemId: 'item-uuid', quantityFulfilled: 2 }],
|
|
237
330
|
* carrier: 'UPS',
|
|
238
331
|
* trackingNumber: '1Z999AA10123456784',
|
|
239
332
|
* });
|
|
@@ -264,22 +357,19 @@ export declare class OrdersClient extends BaseResourceClient<Order, CreateOrderD
|
|
|
264
357
|
/**
|
|
265
358
|
* Get orders for a specific customer
|
|
266
359
|
*/
|
|
267
|
-
listByCustomer(customerId: string): Promise<
|
|
360
|
+
listByCustomer(customerId: string): Promise<OrderListResponse>;
|
|
268
361
|
/**
|
|
269
|
-
* Cancel an order
|
|
362
|
+
* Cancel an order. The backend requires a reason. No refund is issued; use returns.
|
|
270
363
|
*/
|
|
271
|
-
cancel(orderId: string, reason
|
|
364
|
+
cancel(orderId: string, reason: string): Promise<Order>;
|
|
272
365
|
/**
|
|
273
366
|
* Mark order as shipped
|
|
274
367
|
*/
|
|
275
|
-
ship(orderId: string, shipment:
|
|
276
|
-
trackingNumber?: string;
|
|
277
|
-
carrier?: string;
|
|
278
|
-
}): Promise<Order>;
|
|
368
|
+
ship(orderId: string, shipment: ShipOrderDto): Promise<Order>;
|
|
279
369
|
/**
|
|
280
370
|
* Mark order as delivered
|
|
281
371
|
*/
|
|
282
|
-
deliver(orderId: string): Promise<Order>;
|
|
372
|
+
deliver(orderId: string, data?: DeliverOrderDto): Promise<Order>;
|
|
283
373
|
/**
|
|
284
374
|
* Recalculate order totals (shipping, tax, discounts).
|
|
285
375
|
* Only available for orders in pending, confirmed, or processing status
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orders.client.d.ts","sourceRoot":"","sources":["../../../../../src/services/core/orders.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"orders.client.d.ts","sourceRoot":"","sources":["../../../../../src/services/core/orders.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAItD,MAAM,MAAM,WAAW,GACnB,SAAS,GACT,WAAW,GACX,YAAY,GACZ,mBAAmB,GACnB,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,UAAU,CAAC;AAEf,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,gBAAgB,GAChB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,uBAAuB,GACvB,SAAS,GACT,WAAW,GACX,WAAW,GACX,UAAU,GACV,WAAW,CAAC;AAEhB,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,cAAc,CAAC;AAEhF,MAAM,MAAM,kBAAkB,GAC5B,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,oBAAoB,CAAC;AAEvF,MAAM,MAAM,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,mBAAmB,GACnB,SAAS,GACT,qBAAqB,GACrB,WAAW,CAAC;AAEhB,6EAA6E;AAC7E,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,cAAc,CAAC,EAAE,WAAW,CAAC;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,qBAAqB,CAAC,EAAE,kBAAkB,CAAC;IAC3C,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,kBAAkB,CAAC;IAClC,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uFAAuF;IACvF,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,+EAA+E;IAC/E,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC/C,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAC9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0FAA0F;IAC1F,aAAa,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC1C,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;IAC3C,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3D,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,WAAW,CAAC;IACvB,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACtD;AAED,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC;AAErD,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAC9B;AAED,MAAM,MAAM,sBAAsB,GAChC,eAAe,GAAG,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;AAErE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,sBAAsB,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,EAAE,CAAC;IACd,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,gEAAgE;AAChE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACrD,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,uBAAuB;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,iBAAiB,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC;IACrE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACrD,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,KAAK,CAAC;QACnB,gBAAgB,EAAE,MAAM,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;KAC5C,CAAC,CAAC;CACJ;AAID;;;GAGG;AACH,qBAAa,YAAY;IAMrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAN1B,OAAO,CAAC,MAAM,CAAC,CAAmB;IAClC,OAAO,CAAC,aAAa,CAAC,CAAqB;IAC3C,OAAO,CAAC,SAAS,CAAC,CAAiB;gBAGhB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,MAAM;IAGlC,OAAO,KAAK,QAAQ,GAEnB;IAED;;OAEG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIrC;;OAEG;IACG,IAAI,CAAC,OAAO,GAAE,WAAW,CAAC,YAAY,CAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAM/E;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC;;;;;;;;;OASG;IACH,IAAI,KAAK,IAAI,gBAAgB,CAK5B;IAED;;;;;;;;;;;OAWG;IACH,IAAI,YAAY,IAAI,kBAAkB,CAKrC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,QAAQ,IAAI,cAAc,CAK7B;IAED;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC;IAI9D;;OAEG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAI3D;;OAEG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpE;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAK7D;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;IAInE;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,eAAoB,GAAG,OAAO,CAAC,KAAK,CAAC;IAI1E;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIlD;;OAEG;IACG,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC;IAIpF;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAI1D;;;OAGG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IAI7E;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,KAAK,CAAC;IAI7E;;OAEG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI5D;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;IAIzE;;;;OAIG;IACG,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGxE"}
|
|
@@ -1,14 +1,44 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { buildListQueryParams } from './base-resource.js';
|
|
2
2
|
import { OrderEditsClient } from './order-edits.client.js';
|
|
3
3
|
import { FulfillmentsClient } from './fulfillments.client.js';
|
|
4
4
|
import { InvoicesClient } from './invoices.client.js';
|
|
5
5
|
// ==================== Client ====================
|
|
6
|
-
|
|
6
|
+
/**
|
|
7
|
+
* Orders are created only through checkout (`sdk.checkout.adminCreate` for admin-entered
|
|
8
|
+
* orders), so there is no `create`.
|
|
9
|
+
*/
|
|
10
|
+
export class OrdersClient {
|
|
11
|
+
http;
|
|
12
|
+
baseUrl;
|
|
7
13
|
_edits;
|
|
8
14
|
_fulfillments;
|
|
9
15
|
_invoices;
|
|
10
|
-
constructor(
|
|
11
|
-
|
|
16
|
+
constructor(http, baseUrl) {
|
|
17
|
+
this.http = http;
|
|
18
|
+
this.baseUrl = baseUrl;
|
|
19
|
+
}
|
|
20
|
+
get endpoint() {
|
|
21
|
+
return `${this.baseUrl}/v1/orders`;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Get a single order by ID
|
|
25
|
+
*/
|
|
26
|
+
async get(id) {
|
|
27
|
+
return this.http.get(`${this.endpoint}/${id}`);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* List orders with optional pagination and filters
|
|
31
|
+
*/
|
|
32
|
+
async list(options = {}) {
|
|
33
|
+
return this.http.get(this.endpoint, {
|
|
34
|
+
params: buildListQueryParams(options),
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Delete an order by ID
|
|
39
|
+
*/
|
|
40
|
+
async delete(id) {
|
|
41
|
+
await this.http.delete(`${this.endpoint}/${id}`);
|
|
12
42
|
}
|
|
13
43
|
/**
|
|
14
44
|
* Sub-client for order edit sessions (two-phase line item editing).
|
|
@@ -32,7 +62,7 @@ export class OrdersClient extends BaseResourceClient {
|
|
|
32
62
|
* @example
|
|
33
63
|
* ```typescript
|
|
34
64
|
* const fulfillment = await sdk.orders.fulfillments.create(orderId, {
|
|
35
|
-
* items: [{ orderItemId: 'item-uuid',
|
|
65
|
+
* items: [{ orderItemId: 'item-uuid', quantityFulfilled: 2 }],
|
|
36
66
|
* carrier: 'UPS',
|
|
37
67
|
* trackingNumber: '1Z999AA10123456784',
|
|
38
68
|
* });
|
|
@@ -81,10 +111,11 @@ export class OrdersClient extends BaseResourceClient {
|
|
|
81
111
|
return this.list({ filters: { customerId } });
|
|
82
112
|
}
|
|
83
113
|
/**
|
|
84
|
-
* Cancel an order
|
|
114
|
+
* Cancel an order. The backend requires a reason. No refund is issued; use returns.
|
|
85
115
|
*/
|
|
86
116
|
async cancel(orderId, reason) {
|
|
87
|
-
|
|
117
|
+
const body = { reason };
|
|
118
|
+
return this.http.put(`${this.endpoint}/${orderId}/cancel`, body);
|
|
88
119
|
}
|
|
89
120
|
/**
|
|
90
121
|
* Mark order as shipped
|
|
@@ -95,8 +126,8 @@ export class OrdersClient extends BaseResourceClient {
|
|
|
95
126
|
/**
|
|
96
127
|
* Mark order as delivered
|
|
97
128
|
*/
|
|
98
|
-
async deliver(orderId) {
|
|
99
|
-
return this.http.post(`${this.endpoint}/${orderId}/deliver`,
|
|
129
|
+
async deliver(orderId, data = {}) {
|
|
130
|
+
return this.http.post(`${this.endpoint}/${orderId}/deliver`, data);
|
|
100
131
|
}
|
|
101
132
|
/**
|
|
102
133
|
* Recalculate order totals (shipping, tax, discounts).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orders.client.js","sourceRoot":"","sources":["../../../../../src/services/core/orders.client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"orders.client.js","sourceRoot":"","sources":["../../../../../src/services/core/orders.client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAuVtD,mDAAmD;AAEnD;;;GAGG;AACH,MAAM,OAAO,YAAY;IAMJ;IACA;IANX,MAAM,CAAoB;IAC1B,aAAa,CAAsB;IACnC,SAAS,CAAkB;IAEnC,YACmB,IAAgB,EAChB,OAAe;QADf,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAQ;IAC/B,CAAC;IAEJ,IAAY,QAAQ;QAClB,OAAO,GAAG,IAAI,CAAC,OAAO,YAAY,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,UAAqC,EAAE;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAoB,IAAI,CAAC,QAAQ,EAAE;YACrD,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;SACtC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK;QACP,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,YAAY;QACd,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvE,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,QAAQ;QACV,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,IAAoB;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,WAAmB;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAQ,GAAG,IAAI,CAAC,QAAQ,WAAW,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,MAAc;QAC1C,MAAM,IAAI,GAAmB,EAAE,MAAM,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,QAAsB;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,OAAwB,EAAE;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,cAAc,EAAE,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CAAC,OAAe,EAAE,IAA0B;QACjE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,cAAc,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAgB,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,IAAwB;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,IAAyB;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,eAAe,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,IAAqB;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAY,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,IAAqB;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAuB,GAAG,IAAI,CAAC,QAAQ,WAAW,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;CACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { HttpClientTransport as HttpClient } from '../../../core/http-client.js';
|
|
2
|
-
import type { Currency, CreateCurrencyDto, UpdateCurrencyDto, CurrencyFilters,
|
|
2
|
+
import type { Currency, CreateCurrencyDto, UpdateCurrencyDto, CurrencyFilters, ExchangeRateResult, AllExchangeRatesResult, RefreshRatesResult } from './types.js';
|
|
3
3
|
/**
|
|
4
4
|
* CurrenciesClient manages multi-currency configuration and exchange rates.
|
|
5
5
|
*
|
|
@@ -8,16 +8,6 @@ import type { Currency, CreateCurrencyDto, UpdateCurrencyDto, CurrencyFilters, C
|
|
|
8
8
|
* // List all enabled currencies
|
|
9
9
|
* const currencies = await sdk.pricing.currencies.list({ enabledOnly: true });
|
|
10
10
|
*
|
|
11
|
-
* // Get default currency
|
|
12
|
-
* const defaultCurrency = await sdk.pricing.currencies.getDefault();
|
|
13
|
-
*
|
|
14
|
-
* // Convert between currencies
|
|
15
|
-
* const result = await sdk.pricing.currencies.convert({
|
|
16
|
-
* amount: 100,
|
|
17
|
-
* fromCurrency: 'USD',
|
|
18
|
-
* toCurrency: 'EUR',
|
|
19
|
-
* });
|
|
20
|
-
*
|
|
21
11
|
* // Get exchange rate
|
|
22
12
|
* const rate = await sdk.pricing.currencies.getExchangeRate('USD', 'EUR');
|
|
23
13
|
* ```
|
|
@@ -38,10 +28,6 @@ export declare class CurrenciesClient {
|
|
|
38
28
|
* Get a currency by ISO 4217 code
|
|
39
29
|
*/
|
|
40
30
|
getByCode(code: string): Promise<Currency>;
|
|
41
|
-
/**
|
|
42
|
-
* Get the default currency
|
|
43
|
-
*/
|
|
44
|
-
getDefault(): Promise<Currency>;
|
|
45
31
|
/**
|
|
46
32
|
* Create a new currency
|
|
47
33
|
*/
|
|
@@ -51,13 +37,17 @@ export declare class CurrenciesClient {
|
|
|
51
37
|
*/
|
|
52
38
|
update(id: string, data: UpdateCurrencyDto): Promise<Currency>;
|
|
53
39
|
/**
|
|
54
|
-
*
|
|
40
|
+
* Enable a currency tenant-wide
|
|
55
41
|
*/
|
|
56
|
-
|
|
42
|
+
enable(id: string): Promise<Currency>;
|
|
57
43
|
/**
|
|
58
|
-
*
|
|
44
|
+
* Disable a currency tenant-wide
|
|
59
45
|
*/
|
|
60
|
-
|
|
46
|
+
disable(id: string): Promise<Currency>;
|
|
47
|
+
/**
|
|
48
|
+
* Delete a currency (cannot delete default)
|
|
49
|
+
*/
|
|
50
|
+
delete(id: string): Promise<Currency>;
|
|
61
51
|
/**
|
|
62
52
|
* Get exchange rate between two currencies.
|
|
63
53
|
*
|
|
@@ -86,10 +76,6 @@ export declare class CurrenciesClient {
|
|
|
86
76
|
* ```
|
|
87
77
|
*/
|
|
88
78
|
getAllExchangeRates(baseCurrency: string): Promise<AllExchangeRatesResult>;
|
|
89
|
-
/**
|
|
90
|
-
* Update exchange rates for multiple currencies
|
|
91
|
-
*/
|
|
92
|
-
updateExchangeRates(rates: ExchangeRateUpdate[]): Promise<Currency[]>;
|
|
93
79
|
/**
|
|
94
80
|
* Initialize default currencies (USD, CAD, EUR) for a new tenant/store
|
|
95
81
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"currencies.client.d.ts","sourceRoot":"","sources":["../../../../../../src/services/core/pricing/currencies.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACtF,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,
|
|
1
|
+
{"version":3,"file":"currencies.client.d.ts","sourceRoot":"","sources":["../../../../../../src/services/core/pricing/currencies.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACtF,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;GAWG;AACH,qBAAa,gBAAgB;IAEzB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,MAAM;IAGlC;;OAEG;IACG,IAAI,CAAC,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAM9D;;OAEG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIxC;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhD;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIxD;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIpE;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI3C;;OAEG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5C;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI3C;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAM5F;;;;;;;;;;;;OAYG;IACG,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAMhF;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI/C;;;;;;OAMG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE;QAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAUhC"}
|
|
@@ -6,16 +6,6 @@
|
|
|
6
6
|
* // List all enabled currencies
|
|
7
7
|
* const currencies = await sdk.pricing.currencies.list({ enabledOnly: true });
|
|
8
8
|
*
|
|
9
|
-
* // Get default currency
|
|
10
|
-
* const defaultCurrency = await sdk.pricing.currencies.getDefault();
|
|
11
|
-
*
|
|
12
|
-
* // Convert between currencies
|
|
13
|
-
* const result = await sdk.pricing.currencies.convert({
|
|
14
|
-
* amount: 100,
|
|
15
|
-
* fromCurrency: 'USD',
|
|
16
|
-
* toCurrency: 'EUR',
|
|
17
|
-
* });
|
|
18
|
-
*
|
|
19
9
|
* // Get exchange rate
|
|
20
10
|
* const rate = await sdk.pricing.currencies.getExchangeRate('USD', 'EUR');
|
|
21
11
|
* ```
|
|
@@ -48,12 +38,6 @@ export class CurrenciesClient {
|
|
|
48
38
|
async getByCode(code) {
|
|
49
39
|
return this.http.get(`${this.baseUrl}/v1/pricing/currencies/code/${code}`);
|
|
50
40
|
}
|
|
51
|
-
/**
|
|
52
|
-
* Get the default currency
|
|
53
|
-
*/
|
|
54
|
-
async getDefault() {
|
|
55
|
-
return this.http.get(`${this.baseUrl}/v1/pricing/currencies/default`);
|
|
56
|
-
}
|
|
57
41
|
/**
|
|
58
42
|
* Create a new currency
|
|
59
43
|
*/
|
|
@@ -67,16 +51,22 @@ export class CurrenciesClient {
|
|
|
67
51
|
return this.http.patch(`${this.baseUrl}/v1/pricing/currencies/${id}`, data);
|
|
68
52
|
}
|
|
69
53
|
/**
|
|
70
|
-
*
|
|
54
|
+
* Enable a currency tenant-wide
|
|
71
55
|
*/
|
|
72
|
-
async
|
|
73
|
-
return this.http.
|
|
56
|
+
async enable(id) {
|
|
57
|
+
return this.http.patch(`${this.baseUrl}/v1/pricing/currencies/${id}/enable`, {});
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Disable a currency tenant-wide
|
|
61
|
+
*/
|
|
62
|
+
async disable(id) {
|
|
63
|
+
return this.http.patch(`${this.baseUrl}/v1/pricing/currencies/${id}/disable`, {});
|
|
74
64
|
}
|
|
75
65
|
/**
|
|
76
|
-
*
|
|
66
|
+
* Delete a currency (cannot delete default)
|
|
77
67
|
*/
|
|
78
|
-
async
|
|
79
|
-
return this.http.
|
|
68
|
+
async delete(id) {
|
|
69
|
+
return this.http.delete(`${this.baseUrl}/v1/pricing/currencies/${id}`);
|
|
80
70
|
}
|
|
81
71
|
/**
|
|
82
72
|
* Get exchange rate between two currencies.
|
|
@@ -112,14 +102,6 @@ export class CurrenciesClient {
|
|
|
112
102
|
params: { base: baseCurrency },
|
|
113
103
|
});
|
|
114
104
|
}
|
|
115
|
-
/**
|
|
116
|
-
* Update exchange rates for multiple currencies
|
|
117
|
-
*/
|
|
118
|
-
async updateExchangeRates(rates) {
|
|
119
|
-
return this.http.post(`${this.baseUrl}/v1/pricing/currencies/rates/update`, {
|
|
120
|
-
rates,
|
|
121
|
-
});
|
|
122
|
-
}
|
|
123
105
|
/**
|
|
124
106
|
* Initialize default currencies (USD, CAD, EUR) for a new tenant/store
|
|
125
107
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"currencies.client.js","sourceRoot":"","sources":["../../../../../../src/services/core/pricing/currencies.client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"currencies.client.js","sourceRoot":"","sources":["../../../../../../src/services/core/pricing/currencies.client.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,gBAAgB;IAER;IACA;IAFnB,YACmB,IAAgB,EAChB,OAAe;QADf,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAQ;IAC/B,CAAC;IAEJ;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,UAA2B,EAAE;QACtC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;YAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAa,GAAG,IAAI,CAAC,OAAO,wBAAwB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAW,GAAG,IAAI,CAAC,OAAO,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAW,GAAG,IAAI,CAAC,OAAO,+BAA+B,IAAI,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,IAAuB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAW,GAAG,IAAI,CAAC,OAAO,wBAAwB,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,IAAuB;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAW,GAAG,IAAI,CAAC,OAAO,0BAA0B,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAW,GAAG,IAAI,CAAC,OAAO,0BAA0B,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAW,GAAG,IAAI,CAAC,OAAO,0BAA0B,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAW,GAAG,IAAI,CAAC,OAAO,0BAA0B,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB,EAAE,UAAkB;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAClB,GAAG,IAAI,CAAC,OAAO,8BAA8B,YAAY,IAAI,UAAU,EAAE,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,mBAAmB,CAAC,YAAoB;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAyB,GAAG,IAAI,CAAC,OAAO,4BAA4B,EAAE;YACxF,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAa,GAAG,IAAI,CAAC,OAAO,mCAAmC,EAAE,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,OAGlB;QACC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,EAAE,YAAY;YAAE,MAAM,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACtE,IAAI,OAAO,EAAE,OAAO;YAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CACnB,GAAG,IAAI,CAAC,OAAO,oCAAoC,EACnD,EAAE,EACF,EAAE,MAAM,EAAE,CACX,CAAC;IACJ,CAAC;CACF"}
|