@ikas/storefront 2.0.35-alpha.3 → 2.0.35-alpha.5

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.
@@ -1 +1 @@
1
- import o from'../ext/split-on-first/index.js';export{default}from"../node_modules/split-on-first/index.js";
1
+ import e from'../ext/decode-uri-component/index.js';export{default}from"../node_modules/decode-uri-component/index.js";
@@ -1 +1 @@
1
- import e from'../ext/decode-uri-component/index.js';export{default}from"../node_modules/decode-uri-component/index.js";
1
+ import o from'../ext/split-on-first/index.js';export{default}from"../node_modules/split-on-first/index.js";
@@ -0,0 +1,615 @@
1
+ import { CancelledReasonEnum, AdjustmentEnum, AmountTypeEnum, OrderLineItemStatusEnum, ProductOptionTypeEnum, OrderPackageFulfillStatusEnum, OrderPackageStatusEnum, OrderPaymentStatusEnum, ShippingMethodEnum, OrderStatusEnum } from "./../../../__generated__/global-types";
2
+ export interface getOrderByEmail_getOrderByEmail_billingAddress_city {
3
+ __typename: "OrderAddressCity";
4
+ /**
5
+ * It is the code of the city of the address.
6
+ */
7
+ code: string | null;
8
+ /**
9
+ * It is the id of the city of the address.
10
+ */
11
+ id: string | null;
12
+ /**
13
+ * It is the name of the city of the address.
14
+ */
15
+ name: string;
16
+ }
17
+ export interface getOrderByEmail_getOrderByEmail_billingAddress_country {
18
+ __typename: "OrderAddressCountry";
19
+ /**
20
+ * It is the name of the country of the address.
21
+ */
22
+ name: string;
23
+ /**
24
+ * It is the id of the country of the address.
25
+ */
26
+ id: string | null;
27
+ /**
28
+ * It is the code of the country of the address.
29
+ */
30
+ code: string | null;
31
+ }
32
+ export interface getOrderByEmail_getOrderByEmail_billingAddress_district {
33
+ __typename: "OrderAddressDistrict";
34
+ /**
35
+ * It is the name of the district of the address.
36
+ */
37
+ name: string | null;
38
+ /**
39
+ * It is the id of the district of the address.
40
+ */
41
+ id: string | null;
42
+ /**
43
+ * It is the code of the district of the address.
44
+ */
45
+ code: string | null;
46
+ }
47
+ export interface getOrderByEmail_getOrderByEmail_billingAddress_state {
48
+ __typename: "OrderAddressState";
49
+ /**
50
+ * It is the name of the state of the address.
51
+ */
52
+ name: string | null;
53
+ /**
54
+ * It is the id of the state of the address.
55
+ */
56
+ id: string | null;
57
+ /**
58
+ * It is the code of the state of the address.
59
+ */
60
+ code: string | null;
61
+ }
62
+ export interface getOrderByEmail_getOrderByEmail_billingAddress {
63
+ __typename: "OrderAddress";
64
+ /**
65
+ * The street address of the address.
66
+ */
67
+ addressLine1: string;
68
+ /**
69
+ * An optional additional field for the street address of the address.
70
+ */
71
+ addressLine2: string | null;
72
+ /**
73
+ * The city information of the address.
74
+ */
75
+ city: getOrderByEmail_getOrderByEmail_billingAddress_city;
76
+ /**
77
+ * The company of the person associated with the address.
78
+ */
79
+ company: string | null;
80
+ /**
81
+ * The country information of the address.
82
+ */
83
+ country: getOrderByEmail_getOrderByEmail_billingAddress_country;
84
+ /**
85
+ * The district information of the address.
86
+ */
87
+ district: getOrderByEmail_getOrderByEmail_billingAddress_district | null;
88
+ /**
89
+ * The first name of the person associated with the address
90
+ */
91
+ firstName: string;
92
+ /**
93
+ * The identity number of the person associated with the address.
94
+ */
95
+ identityNumber: string | null;
96
+ /**
97
+ * The address"s id of the order address.
98
+ */
99
+ isDefault: boolean;
100
+ /**
101
+ * The last name of the person associated with the address
102
+ */
103
+ lastName: string;
104
+ /**
105
+ * The phone of the person associated with the address.
106
+ */
107
+ phone: string | null;
108
+ /**
109
+ * The postal code of the address.
110
+ */
111
+ postalCode: string | null;
112
+ /**
113
+ * The state information of the address.
114
+ */
115
+ state: getOrderByEmail_getOrderByEmail_billingAddress_state | null;
116
+ /**
117
+ * The tax number of the person associated with the address.
118
+ */
119
+ taxNumber: string | null;
120
+ /**
121
+ * The tax office of the person associated with the address.
122
+ */
123
+ taxOffice: string | null;
124
+ }
125
+ export interface getOrderByEmail_getOrderByEmail_currencyRates {
126
+ __typename: "OrderCurrencyRate";
127
+ /**
128
+ * It is the rate of the currency.
129
+ */
130
+ rate: number;
131
+ /**
132
+ * It is the original rate of the currency.
133
+ */
134
+ originalRate: number;
135
+ /**
136
+ * It is the code of the currency.
137
+ */
138
+ code: string;
139
+ }
140
+ export interface getOrderByEmail_getOrderByEmail_customer {
141
+ __typename: "OrderCustomer";
142
+ /**
143
+ * It is the last name of the customer who created the order.
144
+ */
145
+ lastName: string | null;
146
+ /**
147
+ * It is the first name of the customer who created the order.
148
+ */
149
+ firstName: string | null;
150
+ /**
151
+ * It is the email of the customer who created the order.
152
+ */
153
+ email: string | null;
154
+ /**
155
+ * It is the id of the customer who created the order.
156
+ */
157
+ id: string | null;
158
+ }
159
+ export interface getOrderByEmail_getOrderByEmail_orderAdjustments {
160
+ __typename: "OrderAdjustment";
161
+ type: AdjustmentEnum;
162
+ /**
163
+ * It is the order of the adjustment. Adjustments are applied in this order.
164
+ */
165
+ order: number;
166
+ /**
167
+ * It is the name of the adjustment.
168
+ */
169
+ name: string;
170
+ amountType: AmountTypeEnum;
171
+ /**
172
+ * It is the adjustment amount in the order. This amount can be positive or negative.
173
+ */
174
+ amount: number;
175
+ }
176
+ export interface getOrderByEmail_getOrderByEmail_orderLineItems_discount {
177
+ __typename: "OrderLineDiscount";
178
+ reason: string | null;
179
+ amountType: AmountTypeEnum;
180
+ amount: number;
181
+ }
182
+ export interface getOrderByEmail_getOrderByEmail_orderLineItems_variant_variantValues {
183
+ __typename: "OrderLineVariantVariantValues";
184
+ /**
185
+ * It is the order of variant value. The variant value order starts from 0.
186
+ */
187
+ variantValueName: string | null;
188
+ /**
189
+ * It is the order of variant value. The variant value order starts from 0.
190
+ */
191
+ variantValueId: string;
192
+ /**
193
+ * It is the order of variant value. The variant value order starts from 0.
194
+ */
195
+ variantTypeName: string | null;
196
+ /**
197
+ * It is the order of variant value. The variant value order starts from 0.
198
+ */
199
+ variantTypeId: string;
200
+ /**
201
+ * It is the order of variant value. The variant value order starts from 0.
202
+ */
203
+ order: number;
204
+ }
205
+ export interface getOrderByEmail_getOrderByEmail_orderLineItems_variant {
206
+ __typename: "OrderLineVariant";
207
+ /**
208
+ * It is the barcode list of the variant.
209
+ */
210
+ barcodeList: string[] | null;
211
+ /**
212
+ * It is the id of the variant.
213
+ */
214
+ id: string | null;
215
+ /**
216
+ * It is the main image id of the variant.
217
+ */
218
+ mainImageId: string | null;
219
+ /**
220
+ * It is the name of the variant.
221
+ */
222
+ name: string;
223
+ /**
224
+ * It is the product id of the variant.
225
+ */
226
+ productId: string | null;
227
+ /**
228
+ * It is the sku of the variant.
229
+ */
230
+ sku: string | null;
231
+ /**
232
+ * It is the variant values of the variant.
233
+ */
234
+ variantValues: getOrderByEmail_getOrderByEmail_orderLineItems_variant_variantValues[] | null;
235
+ }
236
+ export interface getOrderByEmail_getOrderByEmail_orderLineItems_options_values {
237
+ __typename: "OrderLineOptionValue";
238
+ name: string | null;
239
+ price: number | null;
240
+ value: string;
241
+ }
242
+ export interface getOrderByEmail_getOrderByEmail_orderLineItems_options {
243
+ __typename: "OrderLineOption";
244
+ /**
245
+ * It is the name of order line option in the order line item.
246
+ */
247
+ name: string;
248
+ /**
249
+ * It is the product option id of the product in the order line item.
250
+ */
251
+ productOptionId: string;
252
+ /**
253
+ * It is the product option set id of the product in the order line item.
254
+ */
255
+ productOptionsSetId: string;
256
+ /**
257
+ * It is the type of the order line option.
258
+ */
259
+ type: ProductOptionTypeEnum;
260
+ values: getOrderByEmail_getOrderByEmail_orderLineItems_options_values[];
261
+ }
262
+ export interface getOrderByEmail_getOrderByEmail_orderLineItems {
263
+ __typename: "OrderLineItem";
264
+ createdAt: any | null;
265
+ /**
266
+ * It is the currency code of the order line item.
267
+ */
268
+ currencyCode: string | null;
269
+ deleted: boolean | null;
270
+ /**
271
+ * Information about the discount. Shows the details of the discount applied to the order line item.
272
+ */
273
+ discount: getOrderByEmail_getOrderByEmail_orderLineItems_discount | null;
274
+ /**
275
+ * It is the discount price of the order line item.
276
+ */
277
+ discountPrice: number | null;
278
+ /**
279
+ * It is the final price of the order line item. If the discount price is less than the sell price, the final price is equal to the discount price.
280
+ */
281
+ finalPrice: number | null;
282
+ id: string;
283
+ /**
284
+ * It is the original order line item id of the line item. If the line item is derived from another line item, this field is filled.
285
+ */
286
+ originalOrderLineItemId: string | null;
287
+ /**
288
+ * It is the selling price of the order line item.
289
+ */
290
+ price: number;
291
+ /**
292
+ * It is the quantity of variant in the order line item.
293
+ */
294
+ quantity: number;
295
+ /**
296
+ * It is the status enum of the order line item
297
+ */
298
+ status: OrderLineItemStatusEnum;
299
+ /**
300
+ * It is the date when the last status of the order line item was updated.
301
+ */
302
+ statusUpdatedAt: any | null;
303
+ /**
304
+ * It is the stock location id of the variant value in the order line item.
305
+ */
306
+ stockLocationId: string | null;
307
+ /**
308
+ * It is the tax value of the order line item.
309
+ */
310
+ taxValue: number | null;
311
+ updatedAt: any | null;
312
+ /**
313
+ * Information about the variant of the order line item.
314
+ */
315
+ variant: getOrderByEmail_getOrderByEmail_orderLineItems_variant;
316
+ /**
317
+ * It is the option information of the variant value in the order line item.
318
+ */
319
+ options: getOrderByEmail_getOrderByEmail_orderLineItems_options[] | null;
320
+ }
321
+ export interface getOrderByEmail_getOrderByEmail_orderPackages_trackingInfo {
322
+ __typename: "TrackingInfo";
323
+ /**
324
+ * It is the tracking number of the order package.
325
+ */
326
+ trackingNumber: string | null;
327
+ /**
328
+ * It is the tracking link of the order package.
329
+ */
330
+ trackingLink: string | null;
331
+ /**
332
+ * Indicates whether the notification is sent to the customer after the cargo is delivered. **isSendNotification** returns true if the notification is sent.
333
+ */
334
+ isSendNotification: boolean | null;
335
+ /**
336
+ * It is the name of the cargo company.
337
+ */
338
+ cargoCompany: string | null;
339
+ }
340
+ export interface getOrderByEmail_getOrderByEmail_orderPackages {
341
+ __typename: "OrderPackage";
342
+ updatedAt: any | null;
343
+ /**
344
+ * It is the stock location id information where the package will be shipped.
345
+ */
346
+ trackingInfo: getOrderByEmail_getOrderByEmail_orderPackages_trackingInfo | null;
347
+ stockLocationId: string;
348
+ /**
349
+ * It is the number of order package. Order package number is created with the order number - order package sequence format.
350
+ */
351
+ orderPackageNumber: string;
352
+ /**
353
+ * It is the fulfill status of the package
354
+ */
355
+ orderPackageFulfillStatus: OrderPackageFulfillStatusEnum;
356
+ /**
357
+ * It is the id list of the order line items in the package.
358
+ */
359
+ orderLineItemIds: string[];
360
+ id: string;
361
+ deleted: boolean | null;
362
+ createdAt: any | null;
363
+ }
364
+ export interface getOrderByEmail_getOrderByEmail_shippingAddress_state {
365
+ __typename: "OrderAddressState";
366
+ /**
367
+ * It is the name of the state of the address.
368
+ */
369
+ name: string | null;
370
+ /**
371
+ * It is the id of the state of the address.
372
+ */
373
+ id: string | null;
374
+ /**
375
+ * It is the code of the state of the address.
376
+ */
377
+ code: string | null;
378
+ }
379
+ export interface getOrderByEmail_getOrderByEmail_shippingAddress_district {
380
+ __typename: "OrderAddressDistrict";
381
+ /**
382
+ * It is the name of the district of the address.
383
+ */
384
+ name: string | null;
385
+ /**
386
+ * It is the id of the district of the address.
387
+ */
388
+ id: string | null;
389
+ /**
390
+ * It is the code of the district of the address.
391
+ */
392
+ code: string | null;
393
+ }
394
+ export interface getOrderByEmail_getOrderByEmail_shippingAddress_country {
395
+ __typename: "OrderAddressCountry";
396
+ /**
397
+ * It is the name of the country of the address.
398
+ */
399
+ name: string;
400
+ /**
401
+ * It is the id of the country of the address.
402
+ */
403
+ id: string | null;
404
+ /**
405
+ * It is the code of the country of the address.
406
+ */
407
+ code: string | null;
408
+ }
409
+ export interface getOrderByEmail_getOrderByEmail_shippingAddress_city {
410
+ __typename: "OrderAddressCity";
411
+ /**
412
+ * It is the id of the city of the address.
413
+ */
414
+ id: string | null;
415
+ /**
416
+ * It is the code of the city of the address.
417
+ */
418
+ code: string | null;
419
+ /**
420
+ * It is the name of the city of the address.
421
+ */
422
+ name: string;
423
+ }
424
+ export interface getOrderByEmail_getOrderByEmail_shippingAddress {
425
+ __typename: "OrderAddress";
426
+ /**
427
+ * The tax office of the person associated with the address.
428
+ */
429
+ taxOffice: string | null;
430
+ /**
431
+ * The tax number of the person associated with the address.
432
+ */
433
+ taxNumber: string | null;
434
+ /**
435
+ * The state information of the address.
436
+ */
437
+ state: getOrderByEmail_getOrderByEmail_shippingAddress_state | null;
438
+ /**
439
+ * The postal code of the address.
440
+ */
441
+ postalCode: string | null;
442
+ /**
443
+ * The phone of the person associated with the address.
444
+ */
445
+ phone: string | null;
446
+ /**
447
+ * The last name of the person associated with the address
448
+ */
449
+ lastName: string;
450
+ /**
451
+ * The address"s id of the order address.
452
+ */
453
+ isDefault: boolean;
454
+ /**
455
+ * The identity number of the person associated with the address.
456
+ */
457
+ identityNumber: string | null;
458
+ /**
459
+ * The first name of the person associated with the address
460
+ */
461
+ firstName: string;
462
+ /**
463
+ * The district information of the address.
464
+ */
465
+ district: getOrderByEmail_getOrderByEmail_shippingAddress_district | null;
466
+ /**
467
+ * The country information of the address.
468
+ */
469
+ country: getOrderByEmail_getOrderByEmail_shippingAddress_country;
470
+ /**
471
+ * The company of the person associated with the address.
472
+ */
473
+ company: string | null;
474
+ /**
475
+ * The city information of the address.
476
+ */
477
+ city: getOrderByEmail_getOrderByEmail_shippingAddress_city;
478
+ /**
479
+ * An optional additional field for the street address of the address.
480
+ */
481
+ addressLine2: string | null;
482
+ /**
483
+ * The street address of the address.
484
+ */
485
+ addressLine1: string;
486
+ }
487
+ export interface getOrderByEmail_getOrderByEmail_shippingLines {
488
+ __typename: "OrderShippingLine";
489
+ /**
490
+ * It is the title of the order shipping line.
491
+ */
492
+ title: string;
493
+ /**
494
+ * It is the tax value of the order shipping line price.
495
+ */
496
+ taxValue: number | null;
497
+ /**
498
+ * It is the price of the order shipping line.
499
+ */
500
+ price: number;
501
+ }
502
+ export interface getOrderByEmail_getOrderByEmail_taxLines {
503
+ __typename: "OrderTaxLine";
504
+ /**
505
+ * It is the percentage of the slice to which the calculated tax amount belongs.
506
+ */
507
+ rate: number;
508
+ /**
509
+ * It is the price of the order tax.
510
+ */
511
+ price: number;
512
+ }
513
+ export interface getOrderByEmail_getOrderByEmail {
514
+ __typename: "Order";
515
+ /**
516
+ * It is the billing address of the order.
517
+ */
518
+ billingAddress: getOrderByEmail_getOrderByEmail_billingAddress | null;
519
+ /**
520
+ * If the order has been cancelled, it indicates the cancellation date of the order.
521
+ */
522
+ cancelledAt: any | null;
523
+ /**
524
+ * It is the cancel reason of the order. If the order has been cancelled, it indicates the cancellation reason of the order.
525
+ */
526
+ cancelReason: CancelledReasonEnum | null;
527
+ createdAt: any | null;
528
+ /**
529
+ * It is the currency value of the order.
530
+ */
531
+ currencyCode: string;
532
+ /**
533
+ * A list of currency rate objects.
534
+ */
535
+ currencyRates: getOrderByEmail_getOrderByEmail_currencyRates[];
536
+ /**
537
+ * Information about the customer. The order does not have to be a customer information. If the order was created by ikasPOS, the customer information may be null.
538
+ */
539
+ customer: getOrderByEmail_getOrderByEmail_customer | null;
540
+ deleted: boolean | null;
541
+ id: string;
542
+ merchantId: string;
543
+ /**
544
+ * An optional note, can attach to the order.
545
+ */
546
+ note: string | null;
547
+ /**
548
+ * The date the order was ordered.
549
+ */
550
+ orderedAt: any | null;
551
+ /**
552
+ * A list of adjustment objects, each containing information about a adjustment in the order.
553
+ */
554
+ orderAdjustments: getOrderByEmail_getOrderByEmail_orderAdjustments[] | null;
555
+ /**
556
+ * A list of line item objects, each containing information about an item in the order.
557
+ */
558
+ orderLineItems: getOrderByEmail_getOrderByEmail_orderLineItems[];
559
+ /**
560
+ * The position of the order in the store's order count starting from 1001. Order numbers are sequential and start from 1001.
561
+ */
562
+ orderNumber: string | null;
563
+ /**
564
+ * A list of order package objects.
565
+ */
566
+ orderPackages: getOrderByEmail_getOrderByEmail_orderPackages[] | null;
567
+ /**
568
+ * It is the package status enum of the order
569
+ */
570
+ orderPackageStatus: OrderPackageStatusEnum | null;
571
+ /**
572
+ * It is the payment status enum of the order
573
+ */
574
+ orderPaymentStatus: OrderPaymentStatusEnum | null;
575
+ /**
576
+ * It is the tag id list in the order.
577
+ */
578
+ orderTagIds: string[] | null;
579
+ /**
580
+ * It is the shipping address of the order.
581
+ */
582
+ shippingAddress: getOrderByEmail_getOrderByEmail_shippingAddress | null;
583
+ /**
584
+ * A list of shipping line objects, each containing information about a shipping in the order.
585
+ */
586
+ shippingLines: getOrderByEmail_getOrderByEmail_shippingLines[] | null;
587
+ /**
588
+ * It is the shipping method enum of the order
589
+ */
590
+ shippingMethod: ShippingMethodEnum;
591
+ /**
592
+ * It is the status enum of the order
593
+ */
594
+ status: OrderStatusEnum;
595
+ /**
596
+ * A list of tax line objects, tax line objects contain the taxes of the shippingLines, orderLineItems, and giftPackageLines.
597
+ */
598
+ taxLines: getOrderByEmail_getOrderByEmail_taxLines[] | null;
599
+ /**
600
+ * The total final price of the order resulting from the apply of `orderAdjustments` , `shippingLines`, and `giftPackageLines` pricing to the order total price.
601
+ */
602
+ totalFinalPrice: number;
603
+ /**
604
+ * It is the sum of the net prices of the line items in the order.
605
+ */
606
+ totalPrice: number;
607
+ updatedAt: any | null;
608
+ }
609
+ export interface getOrderByEmail {
610
+ getOrderByEmail: getOrderByEmail_getOrderByEmail;
611
+ }
612
+ export interface getOrderByEmailVariables {
613
+ email: string;
614
+ orderNumber: string;
615
+ }
@@ -28,6 +28,7 @@ export declare class IkasCustomerAPI {
28
28
  static getCustomer(): Promise<IkasCustomer | undefined>;
29
29
  static saveCustomer(customer: IkasCustomer): Promise<IkasCustomer | undefined>;
30
30
  static getOrders(id?: string): Promise<IkasOrder[] | undefined>;
31
+ static getOrderByEmail(email: string, orderNumber: string): Promise<IkasOrder | undefined>;
31
32
  static getOrderTransactions(params?: {
32
33
  checkoutId?: string;
33
34
  id?: string;