-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Expand file tree
/
Copy pathindex.ts
More file actions
1746 lines (1725 loc) · 52.9 KB
/
index.ts
File metadata and controls
1746 lines (1725 loc) · 52.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { FindParams, HttpTypes, SelectParams } from "@medusajs/types"
import { Client } from "../client"
import { ClientHeaders } from "../types"
export class Store {
/**
* @ignore
*/
private client: Client
/**
* @ignore
*/
constructor(client: Client) {
this.client = client
}
/**
* @tags region
*/
public region = {
/**
* This method retrieves the paginated list of regions in the store. It sends a request to the
* [List Regions API route](https://docs.medusajs.com/api/store#regions_getregions).
*
* Related guide: [How to list regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/list).
*
* @param query - Filters and pagination configurations.
* @param headers - Headers to pass in the request
* @returns The paginated list of regions.
*
* @example
* To retrieve the list of regions:
*
* ```ts
* sdk.store.region.list()
* .then(({ regions, count, limit, offset }) => {
* console.log(regions)
* })
* ```
*
* To configure the pagination, pass the `limit` and `offset` query parameters.
*
* For example, to retrieve only 10 items and skip 10 items:
*
* ```ts
* sdk.store.region.list({
* limit: 10,
* offset: 10
* })
* .then(({ regions, count, limit, offset }) => {
* console.log(regions)
* })
* ```
*
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
* in each region:
*
* ```ts
* sdk.store.region.list({
* fields: "id,*countries"
* })
* .then(({ regions, count, limit, offset }) => {
* console.log(regions)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
list: async (
query?: FindParams & HttpTypes.StoreRegionFilters,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreRegionListResponse>(
`/store/regions`,
{
query,
headers,
}
)
},
/**
* This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/api/store#regions_getregionsid)
* API route.
*
* Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region).
*
* @param id - The region's ID.
* @param query - Configure the fields to retrieve in the region.
* @param headers - Headers to pass in the request
* @returns The region.
*
* @example
* To retrieve a region by its ID:
*
* ```ts
* sdk.store.region.retrieve("reg_123")
* .then(({ region }) => {
* console.log(region)
* })
* ```
*
* To specify the fields and relations to retrieve:
*
* ```ts
* sdk.store.region.retrieve(
* "reg_123",
* {
* fields: "id,*countries"
* }
* )
* .then(({ region }) => {
* console.log(region)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
retrieve: async (
id: string,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreRegionResponse>(
`/store/regions/${id}`,
{
query,
headers,
}
)
},
}
/**
* @tags product
*/
public collection = {
/**
* This method retrieves a paginated list of product collections. It sends a request to the
* [List Collections](https://docs.medusajs.com/api/store#collections_getcollections) API route.
*
* Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/resources/storefront-development/products/collections/list).
*
* @param query - Filters and pagination configurations.
* @param headers - Headers to pass in the request
* @returns The paginated list of collections.
*
* @example
* To retrieve the list of collections:
*
* ```ts
* sdk.store.collection.list()
* .then(({ collections, count, limit, offset }) => {
* console.log(collections)
* })
* ```
*
* To configure the pagination, pass the `limit` and `offset` query parameters.
*
* For example, to retrieve only 10 items and skip 10 items:
*
* ```ts
* sdk.store.collection.list({
* limit: 10,
* offset: 10
* })
* .then(({ collections, count, limit, offset }) => {
* console.log(collections)
* })
* ```
*
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
* in each collection:
*
* ```ts
* sdk.store.collection.list({
* fields: "id,handle"
* })
* .then(({ collections, count, limit, offset }) => {
* console.log(collections)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
list: async (
query?: FindParams & HttpTypes.StoreCollectionListParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCollectionListResponse>(
`/store/collections`,
{
query,
headers,
}
)
},
/**
* This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/api/store#collections_getcollectionsid)
* API route.
*
* Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve).
*
* @param id - The ID of the collection to retrieve.
* @param query - Configure the fields to retrieve in the collection.
* @param headers - Headers to pass in the request
* @returns The collection.
*
* @example
* To retrieve a collection by its ID:
*
* ```ts
* sdk.store.collection.retrieve("pcol_123")
* .then(({ collection }) => {
* console.log(collection)
* })
* ```
*
* To specify the fields and relations to retrieve:
*
* ```ts
* sdk.store.collection.retrieve("pcol_123", {
* fields: "id,handle"
* })
* .then(({ collection }) => {
* console.log(collection)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
retrieve: async (
id: string,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCollectionResponse>(
`/store/collections/${id}`,
{
query,
headers,
}
)
},
}
/**
* @tags product
*/
public category = {
/**
* This method retrieves a paginated list of product categories. It sends a request to the
* [List Categories](https://docs.medusajs.com/api/store#product-categories_getproductcategories) API route.
*
* Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/list).
*
* @param query - Filters and pagination configurations.
* @param headers - Headers to pass in the request.
* @returns The paginated list of categories.
*
* @example
* To retrieve the list of categories:
*
* ```ts
* sdk.store.category.list()
* .then(({ product_categories, count, offset, limit }) => {
* console.log(product_categories)
* })
* ```
*
* To configure the pagination, pass the `limit` and `offset` query parameters.
*
* For example, to retrieve only 10 items and skip 10 items:
*
* ```ts
* sdk.store.category.list({
* limit: 10,
* offset: 10
* })
* .then(({ product_categories, count, offset, limit }) => {
* console.log(product_categories)
* })
* ```
*
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
* in each category:
*
* ```ts
* sdk.store.category.list({
* fields: "id,*parent_category"
* })
* .then(({ product_categories, count, offset, limit }) => {
* console.log(product_categories)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
list: async (
query?: FindParams & HttpTypes.StoreProductCategoryListParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreProductCategoryListResponse>(
`/store/product-categories`,
{
query,
headers,
}
)
},
/**
* This method retrieves a category by its ID. It sends a request to the
* [Retrieve Product Category](https://docs.medusajs.com/api/store#product-categories_getproductcategoriesid).
*
* Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve).
*
* @param id - The ID of the category to retrieve.
* @param query - Configure the fields to retrieve in the category.
* @param headers - Headers to pass in the request
* @returns The category.
*
* @example
* To retrieve a category by its ID:
*
* ```ts
* sdk.store.category.retrieve("pcat_123")
* .then(({ product_category }) => {
* console.log(product_category)
* })
* ```
*
* To specify the fields and relations to retrieve:
*
* ```ts
* sdk.store.category.retrieve("pcat_123", {
* fields: "id,*parent_category"
* })
* .then(({ product_category }) => {
* console.log(product_category)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
retrieve: async (
id: string,
query?: HttpTypes.StoreProductCategoryParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreProductCategoryResponse>(
`/store/product-categories/${id}`,
{
query,
headers,
}
)
},
}
/**
* @tags product
*/
public product = {
/**
* This method retrieves a list of products. It sends a request to the
* [List Products API route](https://docs.medusajs.com/api/store#products_getproducts).
*
* Related guides:
*
* - [How to list products in a storefront](https://docs.medusajs.com/resources/storefront-development/products/list).
* - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/resources/storefront-development/products/price)
*
* @param query - Filters and pagination configurations.
* @param headers - Headers to pass in the request.
* @returns The paginated list of products.
*
* @example
* To retrieve the list of products:
*
* ```ts
* sdk.store.product.list()
* .then(({ products, count, offset, limit }) => {
* console.log(products)
* })
* ```
*
* To configure the pagination, pass the `limit` and `offset` query parameters.
*
* For example, to retrieve only 10 items and skip 10 items:
*
* ```ts
* sdk.store.product.list({
* limit: 10,
* offset: 10
* })
* .then(({ products, count, offset, limit }) => {
* console.log(products)
* })
* ```
*
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
* in each product:
*
* ```ts
* sdk.store.product.list({
* fields: "id,*collection"
* })
* .then(({ products, count, offset, limit }) => {
* console.log(products)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
list: async (
query?: HttpTypes.StoreProductListParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreProductListResponse>(
`/store/products`,
{
query,
headers,
}
)
},
/**
* This method is used to retrieve a product by its ID. It sends a request to the
* [Get Product](https://docs.medusajs.com/api/store#products_getproductsid) API route.
*
* Related guides:
*
* - [How to retrieve a product in the storefront](https://docs.medusajs.com/resources/storefront-development/products/retrieve).
* - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/resources/storefront-development/products/price)
*
* @param id - The product's ID.
* @param query - Configure the fields to retrieve in the product.
* @param headers - Headers to pass in the request
* @returns The product.
*
* @example
* To retrieve a product by its ID:
*
* ```ts
* sdk.store.product.retrieve("prod_123")
* .then(({ product }) => {
* console.log(product)
* })
* ```
*
* To specify the fields and relations to retrieve:
*
* ```ts
* sdk.store.product.retrieve("prod_123", {
* fields: "id,*collection"
* })
* .then(({ product }) => {
* console.log(product)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
retrieve: async (
id: string,
query?: HttpTypes.StoreProductParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreProductResponse>(
`/store/products/${id}`,
{
query,
headers,
}
)
},
}
/**
* Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/resources/storefront-development/cart).
*
* @tags cart
*/
public cart = {
/**
* This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/api/store#carts_postcarts)
* API route.
*
* Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/create).
*
* @param body - The details of the cart to create.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The created cart.
*
* @example
* sdk.store.cart.create({
* region_id: "reg_123"
* })
* .then(({ cart }) => {
* console.log(cart)
* })
*/
create: async (
body: HttpTypes.StoreCreateCart,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(`/store/carts`, {
method: "POST",
headers,
body,
query,
})
},
/**
* This method updates a cart. It sends a request to the
* [Update Cart](https://docs.medusajs.com/api/store#carts_postcartsid) API route.
*
* Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/update).
*
* @param id - The cart's ID.
* @param body - The data to update in the cart.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The updated cart.
*
* @example
* sdk.store.cart.update("cart_123", {
* region_id: "reg_123"
* })
* .then(({ cart }) => {
* console.log(cart)
* })
*/
update: async (
id: string,
body: HttpTypes.StoreUpdateCart,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${id}`,
{
method: "POST",
headers,
body,
query,
}
)
},
/**
* This method retrieves a cart by its ID. It sends a request to the
* [Get Cart](https://docs.medusajs.com/api/store#carts_getcartsid) API route.
*
* Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/retrieve).
*
* @param id - The cart's ID.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The cart's details.
*
* @example
* To retrieve a cart by its ID:
*
* ```ts
* sdk.store.cart.retrieve("cart_123")
* .then(({ cart }) => {
* console.log(cart)
* })
* ```
*
* To specify the fields and relations to retrieve:
*
* ```ts
* sdk.store.cart.retrieve("cart_123", {
* fields: "id,*items"
* })
* .then(({ cart }) => {
* console.log(cart)
* })
* ```
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
retrieve: async (
id: string,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${id}`,
{
headers,
query,
}
)
},
/**
* This methods adds a product variant to the cart as a line item. It sends a request to the
* [Add Line Item](https://docs.medusajs.com/api/store#carts_postcartsidlineitems) API route.
*
* Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
*
* @param cartId - The cart's ID.
* @param body - The details of the item to add.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The cart's details.
*
* @example
* sdk.store.cart.createLineItem("cart_123", {
* variant_id: "variant_123",
* quantity: 1
* })
* .then(({ cart }) => {
* console.log(cart)
* })
*/
createLineItem: async (
cartId: string,
body: HttpTypes.StoreAddCartLineItem,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${cartId}/line-items`,
{
method: "POST",
headers,
body,
query,
}
)
},
/**
* This method updates a line item in a cart. It sends a request to the
* [Update Line Item](https://docs.medusajs.com/api/store#carts_postcartsidlineitemsline_id) API route.
*
* Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
*
* @param cartId - The cart's ID.
* @param lineItemId - The line item's ID.
* @param body - The data to update.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The cart's details.
*
* @example
* sdk.store.cart.updateLineItem(
* "cart_123",
* "li_123",
* {
* quantity: 1
* }
* )
* .then(({ cart }) => {
* console.log(cart)
* })
*/
updateLineItem: async (
cartId: string,
lineItemId: string,
body: HttpTypes.StoreUpdateCartLineItem,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${cartId}/line-items/${lineItemId}`,
{
method: "POST",
headers,
body,
query,
}
)
},
/**
* This method deletes a line item from a cart. It sends a request to the
* [Remove Line Item](https://docs.medusajs.com/api/store#carts_deletecartsidlineitemsline_id) API route.
*
* Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
*
* @param cartId - The cart's ID.
* @param lineItemId - The item's ID.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The deletion's details.
*
* @example
* sdk.store.cart.deleteLineItem(
* "cart_123",
* "li_123"
* )
* .then(({ deleted, parent: cart }) => {
* console.log(deleted, cart)
* })
*/
deleteLineItem: async (
cartId: string,
lineItemId: string,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreLineItemDeleteResponse>(
`/store/carts/${cartId}/line-items/${lineItemId}`,
{
method: "DELETE",
query,
headers,
}
)
},
/**
* This method adds a shipping method to a cart. It sends a request to
* the [Add Shipping Method](https://docs.medusajs.com/api/store#carts_postcartsidshippingmethods) API routes.
*
* Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
*
* @param cartId - The cart's ID.
* @param body - The shipping method's details.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The cart's details.
*
* @example
* sdk.store.cart.addShippingMethod("cart_123", {
* option_id: "so_123",
* data: {
* // custom data for fulfillment provider.
* }
* })
* .then(({ cart }) => {
* console.log(cart)
* })
*/
addShippingMethod: async (
cartId: string,
body: HttpTypes.StoreAddCartShippingMethods,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${cartId}/shipping-methods`,
{
method: "POST",
headers,
body,
query,
}
)
},
/**
* This method adds a promotion code to the current cart
* The method sends a request to the [Add Promotion Code](https://docs.medusajs.com/api/store#carts_postcartsidpromotions) API route.
*
* @example
* sdk.store.cart.addPromotions("cart_123", {
* promo_codes: ["20OFF"]
* })
* .then(({ cart }) => {
* console.log(cart)
* })
*/
addPromotions: async (
cartId: string,
body: HttpTypes.StoreCartAddPromotion,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${cartId}/promotions`,
{
method: "POST",
headers,
body,
query,
}
)
},
/**
* This method removes promotion codes from the current cart
* The method sends a request to the [Remove Promotion Code](https://docs.medusajs.com/api/store#carts_deletecartsidpromotions) API route.
*
* @example
* sdk.store.cart.removePromotions("cart_123", {
* promo_codes: ["20OFF"]
* })
* .then(({ cart }) => {
* console.log(cart)
* })
*/
removePromotions: async (
cartId: string,
body: HttpTypes.StoreCartRemovePromotion,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${cartId}/promotions`,
{
method: "DELETE",
headers,
body,
query,
}
)
},
/**
* This method completes a cart and places the order. It's the last step of the checkout flow.
* The method sends a request to the [Complete Cart](https://docs.medusajs.com/api/store#carts_postcartsidcomplete)
* API route.
*
* Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart).
*
* @param cartId - The cart's ID.
* @param query - Configure the fields to retrieve in the created order.
* @param headers - Headers to pass in the request.
* @returns The order's details, if it was placed successfully. Otherwise, the cart is returned with an error.
*
* @example
* sdk.store.cart.complete("cart_123")
* .then((data) => {
* if(data.type === "cart") {
* // an error occurred
* console.log(data.error, data.cart)
* } else {
* // order placed successfully
* console.log(data.order)
* }
* })
*/
complete: async (
cartId: string,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCompleteCartResponse>(
`/store/carts/${cartId}/complete`,
{
method: "POST",
headers,
query,
}
)
},
/**
* This method updates the customer of a cart.
*
* @param id - The cart's ID.
* @param query - Configure the fields to retrieve in the cart.
* @param headers - Headers to pass in the request.
* @returns The updated cart.
*
* @example
* // TODO must be authenticated as the customer to set the cart's customer
* sdk.store.cart.transferCart("cart_123")
* .then(({ cart }) => {
* console.log(cart)
* })
*/
transferCart: async (
id: string,
query?: SelectParams,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreCartResponse>(
`/store/carts/${id}/customer`,
{
method: "POST",
headers,
query,
}
)
},
}
/**
* @tags fulfillment
*/
public fulfillment = {
/**
* This method retrieves the list of shipping options for a cart. It sends a request to
* the [List Shipping Options](https://docs.medusajs.com/api/store#shipping-options_getshippingoptions)
* API route.
*
* Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
*
* @param query - The cart's details along with configurations of the fields to retrieve in the options.
* @param headers - Headers to pass in the request.
* @returns The shipping options that can be used for the cart.
*
* @example
* sdk.store.fulfillment.listCartOptions({
* cart_id: "cart_123"
* })
* .then(({ shipping_options }) => {
* console.log(shipping_options)
* })
*/
listCartOptions: async (
query?: HttpTypes.StoreGetShippingOptionList,
headers?: ClientHeaders
) => {
return this.client.fetch<HttpTypes.StoreShippingOptionListResponse>(
`/store/shipping-options`,
{
headers,
query,
}
)
},
/**
* This method calculates the price of a shipping option in a cart, which is useful during checkout.
* It sends a request to the [Calculate Shipping Option Price](https://docs.medusajs.com/api/store#shipping-options_postshippingoptionsidcalculate)
* API route.
*
* @param id - The shipping option's ID.
* @param body - The price calculation's details.
* @param query - Configure the fields to retrieve in the shipping option.
* @param headers - Headers to pass in the request.
* @returns The shipping option's details.
*
* @example
* sdk.store.fulfillment.calculate("so_123", {
* cart_id: "cart_123"
* })
* .then(({ shipping_option }) => {
* console.log(shipping_option)
* })
*/
calculate: async (
id: string,
body: HttpTypes.StoreCalculateShippingOptionPrice,
query?: HttpTypes.SelectParams,
headers?: ClientHeaders
) => {
return await this.client.fetch<HttpTypes.StoreShippingOptionResponse>(
`/store/shipping-options/${id}/calculate`,
{
method: "POST",
headers,
body,
query,
}
)
},
}
/**
* @tags payment
*/
public payment = {
/**
* This method retrieves the payment providers available in a region, which is useful during checkout.
* It sends a request to the [List Payment Providers](https://docs.medusajs.com/api/store#payment-providers_getpaymentproviders)
* API route.
*
* Related guide: [Implement payment step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/payment).
*
* @param query - The filters to apply on the retrieved providers, along with configurations of the
* fields to retrieve in the options.
* @param headers - Headers to pass in the request.
* @returns The list of payment providers.
*
* @example
* To retrieve the list of payment providers for a region:
*
* ```ts
* sdk.store.payment.listPaymentProviders({
* region_id: "reg_123"
* })
* .then(({ payment_providers, count, offset, limit }) => {
* console.log(payment_providers)
* })
* ```
*
* To configure the pagination, pass the `limit` and `offset` query parameters.
*
* For example, to retrieve only 10 items and skip 10 items:
*
* ```ts
* sdk.store.payment.listPaymentProviders({
* region_id: "reg_123",
* limit: 10,
* offset: 10
* })
* .then(({ payment_providers, count, offset, limit }) => {
* console.log(payment_providers)
* })
* ```
*
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
* in each provider: