@medusajs/js-sdk 2.0.0-rc-20241022183311 → 2.0.1-snapshot-20241025090810
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/admin/api-key.d.ts +8 -8
- package/dist/admin/api-key.js +8 -8
- package/dist/admin/campaign.d.ts +8 -8
- package/dist/admin/campaign.js +8 -8
- package/dist/admin/claim.d.ts +22 -22
- package/dist/admin/claim.js +22 -22
- package/dist/admin/currency.d.ts +4 -4
- package/dist/admin/currency.js +4 -4
- package/dist/admin/customer-group.d.ts +8 -8
- package/dist/admin/customer-group.js +8 -8
- package/dist/admin/customer.d.ts +27 -7
- package/dist/admin/customer.d.ts.map +1 -1
- package/dist/admin/customer.js +33 -7
- package/dist/admin/customer.js.map +1 -1
- package/dist/admin/exchange.d.ts +21 -21
- package/dist/admin/exchange.js +21 -21
- package/dist/admin/fulfillment-provider.d.ts +2 -2
- package/dist/admin/fulfillment-provider.js +2 -2
- package/dist/admin/fulfillment-set.d.ts +6 -6
- package/dist/admin/fulfillment-set.js +6 -6
- package/dist/admin/fulfillment.d.ts +3 -3
- package/dist/admin/fulfillment.js +3 -3
- package/dist/admin/inventory-item.d.ts +12 -12
- package/dist/admin/inventory-item.js +12 -12
- package/dist/admin/invite.d.ts +8 -8
- package/dist/admin/invite.js +8 -8
- package/dist/admin/payment-collection.d.ts +0 -2
- package/dist/admin/payment-collection.d.ts.map +1 -1
- package/dist/admin/payment-collection.js +0 -12
- package/dist/admin/payment-collection.js.map +1 -1
- package/dist/auth/index.d.ts +10 -10
- package/dist/auth/index.js +10 -10
- package/dist/esm/admin/api-key.d.ts +8 -8
- package/dist/esm/admin/api-key.js +8 -8
- package/dist/esm/admin/campaign.d.ts +8 -8
- package/dist/esm/admin/campaign.js +8 -8
- package/dist/esm/admin/claim.d.ts +22 -22
- package/dist/esm/admin/claim.js +22 -22
- package/dist/esm/admin/currency.d.ts +4 -4
- package/dist/esm/admin/currency.js +4 -4
- package/dist/esm/admin/customer-group.d.ts +8 -8
- package/dist/esm/admin/customer-group.js +8 -8
- package/dist/esm/admin/customer.d.ts +27 -7
- package/dist/esm/admin/customer.d.ts.map +1 -1
- package/dist/esm/admin/customer.js +35 -7
- package/dist/esm/admin/customer.js.map +1 -1
- package/dist/esm/admin/exchange.d.ts +21 -21
- package/dist/esm/admin/exchange.js +21 -21
- package/dist/esm/admin/fulfillment-provider.d.ts +2 -2
- package/dist/esm/admin/fulfillment-provider.js +2 -2
- package/dist/esm/admin/fulfillment-set.d.ts +6 -6
- package/dist/esm/admin/fulfillment-set.js +6 -6
- package/dist/esm/admin/fulfillment.d.ts +3 -3
- package/dist/esm/admin/fulfillment.js +3 -3
- package/dist/esm/admin/inventory-item.d.ts +12 -12
- package/dist/esm/admin/inventory-item.js +12 -12
- package/dist/esm/admin/invite.d.ts +8 -8
- package/dist/esm/admin/invite.js +8 -8
- package/dist/esm/admin/payment-collection.d.ts +0 -2
- package/dist/esm/admin/payment-collection.d.ts.map +1 -1
- package/dist/esm/admin/payment-collection.js +0 -16
- package/dist/esm/admin/payment-collection.js.map +1 -1
- package/dist/esm/auth/index.d.ts +10 -10
- package/dist/esm/auth/index.js +10 -10
- package/dist/esm/store/index.d.ts +73 -73
- package/dist/esm/store/index.js +73 -73
- package/dist/store/index.d.ts +73 -73
- package/dist/store/index.js +73 -73
- package/package.json +2 -2
@@ -12,7 +12,7 @@ export declare class InventoryItem {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method creates an inventory item. It sends a request to the
|
15
|
-
* [Create Inventory Item](https://docs.medusajs.com/
|
15
|
+
* [Create Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitems)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param body - The inventory item's details.
|
@@ -31,7 +31,7 @@ export declare class InventoryItem {
|
|
31
31
|
create(body: HttpTypes.AdminCreateInventoryItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
|
32
32
|
/**
|
33
33
|
* This method updates an inventory level. It sends a request to the
|
34
|
-
* [Update Inventory Item](https://docs.medusajs.com/
|
34
|
+
* [Update Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsid)
|
35
35
|
* API route.
|
36
36
|
*
|
37
37
|
* @param id - The inventory item's ID.
|
@@ -51,7 +51,7 @@ export declare class InventoryItem {
|
|
51
51
|
update(id: string, body: HttpTypes.AdminUpdateInventoryItem, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
|
52
52
|
/**
|
53
53
|
* This method retrieves a paginated list of inventory items. It sends a request to the
|
54
|
-
* [List Inventory Items](https://docs.medusajs.com/
|
54
|
+
* [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
55
55
|
* API route.
|
56
56
|
*
|
57
57
|
* @param query - Filters and pagination configurations.
|
@@ -94,12 +94,12 @@ export declare class InventoryItem {
|
|
94
94
|
* })
|
95
95
|
* ```
|
96
96
|
*
|
97
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
97
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
98
98
|
*/
|
99
99
|
list(query?: HttpTypes.AdminInventoryItemParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemListResponse>;
|
100
100
|
/**
|
101
101
|
* This method retrieves an inventory item by its ID. It sends a request to the
|
102
|
-
* [Get Inventory Item](https://docs.medusajs.com/
|
102
|
+
* [Get Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitemsid) API route.
|
103
103
|
*
|
104
104
|
* @param id - The inventory item's ID.
|
105
105
|
* @param query - Configure the fields to retrieve in the inventory item.
|
@@ -127,12 +127,12 @@ export declare class InventoryItem {
|
|
127
127
|
* })
|
128
128
|
* ```
|
129
129
|
*
|
130
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
130
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
131
131
|
*/
|
132
132
|
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
|
133
133
|
/**
|
134
134
|
* This method deletes an inventory item. This sends a request to the
|
135
|
-
* [Delete Inventory Item](https://docs.medusajs.com/
|
135
|
+
* [Delete Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsid)
|
136
136
|
* API route.
|
137
137
|
*
|
138
138
|
* @param id - The inventory item's ID.
|
@@ -148,7 +148,7 @@ export declare class InventoryItem {
|
|
148
148
|
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemDeleteResponse>;
|
149
149
|
/**
|
150
150
|
* This method retrieves a paginated list of inventory levels that belong to an inventory item.
|
151
|
-
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/
|
151
|
+
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
152
152
|
* API route.
|
153
153
|
*
|
154
154
|
* @param id - The inventory item's ID.
|
@@ -192,7 +192,7 @@ export declare class InventoryItem {
|
|
192
192
|
* })
|
193
193
|
* ```
|
194
194
|
*
|
195
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
195
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
196
196
|
*/
|
197
197
|
listLevels(id: string, query?: HttpTypes.AdminInventoryLevelFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryLevelListResponse>;
|
198
198
|
/**
|
@@ -200,7 +200,7 @@ export declare class InventoryItem {
|
|
200
200
|
* stock location.
|
201
201
|
*
|
202
202
|
* This method sends a request to the
|
203
|
-
* [Update Inventory Level](https://docs.medusajs.com/
|
203
|
+
* [Update Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
|
204
204
|
* API route.
|
205
205
|
*
|
206
206
|
* @param id - The inventory item's ID.
|
@@ -228,7 +228,7 @@ export declare class InventoryItem {
|
|
228
228
|
* and a stock location.
|
229
229
|
*
|
230
230
|
* This method sends a request to the
|
231
|
-
* [Remove Inventory Level](https://docs.medusajs.com/
|
231
|
+
* [Remove Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
|
232
232
|
* API route.
|
233
233
|
*
|
234
234
|
* @param id - The inventory item's ID.
|
@@ -248,7 +248,7 @@ export declare class InventoryItem {
|
|
248
248
|
deleteLevel(id: string, locationId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryLevelDeleteResponse>;
|
249
249
|
/**
|
250
250
|
* This method manages the inventory levels of an inventory item. It sends a request to the
|
251
|
-
* [Manage Inventory Levels](https://docs.medusajs.com/
|
251
|
+
* [Manage Inventory Levels](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
|
252
252
|
* API route.
|
253
253
|
*
|
254
254
|
* @param id - The inventory item's ID.
|
@@ -10,7 +10,7 @@ class InventoryItem {
|
|
10
10
|
}
|
11
11
|
/**
|
12
12
|
* This method creates an inventory item. It sends a request to the
|
13
|
-
* [Create Inventory Item](https://docs.medusajs.com/
|
13
|
+
* [Create Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitems)
|
14
14
|
* API route.
|
15
15
|
*
|
16
16
|
* @param body - The inventory item's details.
|
@@ -36,7 +36,7 @@ class InventoryItem {
|
|
36
36
|
}
|
37
37
|
/**
|
38
38
|
* This method updates an inventory level. It sends a request to the
|
39
|
-
* [Update Inventory Item](https://docs.medusajs.com/
|
39
|
+
* [Update Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsid)
|
40
40
|
* API route.
|
41
41
|
*
|
42
42
|
* @param id - The inventory item's ID.
|
@@ -63,7 +63,7 @@ class InventoryItem {
|
|
63
63
|
}
|
64
64
|
/**
|
65
65
|
* This method retrieves a paginated list of inventory items. It sends a request to the
|
66
|
-
* [List Inventory Items](https://docs.medusajs.com/
|
66
|
+
* [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
67
67
|
* API route.
|
68
68
|
*
|
69
69
|
* @param query - Filters and pagination configurations.
|
@@ -106,7 +106,7 @@ class InventoryItem {
|
|
106
106
|
* })
|
107
107
|
* ```
|
108
108
|
*
|
109
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
109
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
110
110
|
*/
|
111
111
|
async list(query, headers) {
|
112
112
|
return await this.client.fetch(`/admin/inventory-items`, {
|
@@ -116,7 +116,7 @@ class InventoryItem {
|
|
116
116
|
}
|
117
117
|
/**
|
118
118
|
* This method retrieves an inventory item by its ID. It sends a request to the
|
119
|
-
* [Get Inventory Item](https://docs.medusajs.com/
|
119
|
+
* [Get Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitemsid) API route.
|
120
120
|
*
|
121
121
|
* @param id - The inventory item's ID.
|
122
122
|
* @param query - Configure the fields to retrieve in the inventory item.
|
@@ -144,7 +144,7 @@ class InventoryItem {
|
|
144
144
|
* })
|
145
145
|
* ```
|
146
146
|
*
|
147
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
147
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
148
148
|
*/
|
149
149
|
async retrieve(id, query, headers) {
|
150
150
|
return await this.client.fetch(`/admin/inventory-items/${id}`, {
|
@@ -154,7 +154,7 @@ class InventoryItem {
|
|
154
154
|
}
|
155
155
|
/**
|
156
156
|
* This method deletes an inventory item. This sends a request to the
|
157
|
-
* [Delete Inventory Item](https://docs.medusajs.com/
|
157
|
+
* [Delete Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsid)
|
158
158
|
* API route.
|
159
159
|
*
|
160
160
|
* @param id - The inventory item's ID.
|
@@ -175,7 +175,7 @@ class InventoryItem {
|
|
175
175
|
}
|
176
176
|
/**
|
177
177
|
* This method retrieves a paginated list of inventory levels that belong to an inventory item.
|
178
|
-
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/
|
178
|
+
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
179
179
|
* API route.
|
180
180
|
*
|
181
181
|
* @param id - The inventory item's ID.
|
@@ -219,7 +219,7 @@ class InventoryItem {
|
|
219
219
|
* })
|
220
220
|
* ```
|
221
221
|
*
|
222
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
222
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
223
223
|
*/
|
224
224
|
async listLevels(id, query, headers) {
|
225
225
|
return await this.client.fetch(`/admin/inventory-items/${id}/location-levels`, {
|
@@ -232,7 +232,7 @@ class InventoryItem {
|
|
232
232
|
* stock location.
|
233
233
|
*
|
234
234
|
* This method sends a request to the
|
235
|
-
* [Update Inventory Level](https://docs.medusajs.com/
|
235
|
+
* [Update Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
|
236
236
|
* API route.
|
237
237
|
*
|
238
238
|
* @param id - The inventory item's ID.
|
@@ -267,7 +267,7 @@ class InventoryItem {
|
|
267
267
|
* and a stock location.
|
268
268
|
*
|
269
269
|
* This method sends a request to the
|
270
|
-
* [Remove Inventory Level](https://docs.medusajs.com/
|
270
|
+
* [Remove Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
|
271
271
|
* API route.
|
272
272
|
*
|
273
273
|
* @param id - The inventory item's ID.
|
@@ -292,7 +292,7 @@ class InventoryItem {
|
|
292
292
|
}
|
293
293
|
/**
|
294
294
|
* This method manages the inventory levels of an inventory item. It sends a request to the
|
295
|
-
* [Manage Inventory Levels](https://docs.medusajs.com/
|
295
|
+
* [Manage Inventory Levels](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
|
296
296
|
* API route.
|
297
297
|
*
|
298
298
|
* @param id - The inventory item's ID.
|
package/dist/admin/invite.d.ts
CHANGED
@@ -15,7 +15,7 @@ export declare class Invite {
|
|
15
15
|
* the {@link Auth.register}.
|
16
16
|
*
|
17
17
|
* This method sends a request to the [Accept Invite]
|
18
|
-
* (https://docs.medusajs.com/
|
18
|
+
* (https://docs.medusajs.com/api/admin#invites_postinvitesaccept)
|
19
19
|
* API route.
|
20
20
|
*
|
21
21
|
* @param input - The details of the user to create.
|
@@ -52,7 +52,7 @@ export declare class Invite {
|
|
52
52
|
}, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminAcceptInviteResponse>;
|
53
53
|
/**
|
54
54
|
* This method creates an invite. It sends a request to the
|
55
|
-
* [Create Invite](https://docs.medusajs.com/
|
55
|
+
* [Create Invite](https://docs.medusajs.com/api/admin#invites_postinvites)
|
56
56
|
* API route.
|
57
57
|
*
|
58
58
|
* @param body - The invite's details.
|
@@ -71,7 +71,7 @@ export declare class Invite {
|
|
71
71
|
create(body: HttpTypes.AdminCreateInvite, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
72
72
|
/**
|
73
73
|
* This method retrieves an invite by its ID. It sends a request to the
|
74
|
-
* [Get Invite](https://docs.medusajs.com/
|
74
|
+
* [Get Invite](https://docs.medusajs.com/api/admin#invites_getinvitesid)
|
75
75
|
* API route.
|
76
76
|
*
|
77
77
|
* @param id - The invite's ID.
|
@@ -100,12 +100,12 @@ export declare class Invite {
|
|
100
100
|
* })
|
101
101
|
* ```
|
102
102
|
*
|
103
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
103
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
104
104
|
*/
|
105
105
|
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
106
106
|
/**
|
107
107
|
* This method retrieves a paginated list of invites. It sends a request to the
|
108
|
-
* [List Invites](https://docs.medusajs.com/
|
108
|
+
* [List Invites](https://docs.medusajs.com/api/admin#invites_getinvites)
|
109
109
|
* API route.
|
110
110
|
*
|
111
111
|
* @param queryParams - Filters and pagination configurations.
|
@@ -148,12 +148,12 @@ export declare class Invite {
|
|
148
148
|
* })
|
149
149
|
* ```
|
150
150
|
*
|
151
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
151
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
152
152
|
*/
|
153
153
|
list(queryParams?: FindParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteListResponse>;
|
154
154
|
/**
|
155
155
|
* This method refreshes the token of an invite. It sends a request to the
|
156
|
-
* [Refresh Invite Token](https://docs.medusajs.com/
|
156
|
+
* [Refresh Invite Token](https://docs.medusajs.com/api/admin#invites_postinvitesidresend)
|
157
157
|
* API route.
|
158
158
|
*
|
159
159
|
* @param id - The invite's ID.
|
@@ -169,7 +169,7 @@ export declare class Invite {
|
|
169
169
|
resend(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
170
170
|
/**
|
171
171
|
* This method deletes an invite. It sends a request to the
|
172
|
-
* [Delete Invite](https://docs.medusajs.com/
|
172
|
+
* [Delete Invite](https://docs.medusajs.com/api/admin#invites_deleteinvitesid)
|
173
173
|
* API route.
|
174
174
|
*
|
175
175
|
* @param id - The invite's ID.
|
package/dist/admin/invite.js
CHANGED
@@ -13,7 +13,7 @@ class Invite {
|
|
13
13
|
* the {@link Auth.register}.
|
14
14
|
*
|
15
15
|
* This method sends a request to the [Accept Invite]
|
16
|
-
* (https://docs.medusajs.com/
|
16
|
+
* (https://docs.medusajs.com/api/admin#invites_postinvitesaccept)
|
17
17
|
* API route.
|
18
18
|
*
|
19
19
|
* @param input - The details of the user to create.
|
@@ -53,7 +53,7 @@ class Invite {
|
|
53
53
|
}
|
54
54
|
/**
|
55
55
|
* This method creates an invite. It sends a request to the
|
56
|
-
* [Create Invite](https://docs.medusajs.com/
|
56
|
+
* [Create Invite](https://docs.medusajs.com/api/admin#invites_postinvites)
|
57
57
|
* API route.
|
58
58
|
*
|
59
59
|
* @param body - The invite's details.
|
@@ -79,7 +79,7 @@ class Invite {
|
|
79
79
|
}
|
80
80
|
/**
|
81
81
|
* This method retrieves an invite by its ID. It sends a request to the
|
82
|
-
* [Get Invite](https://docs.medusajs.com/
|
82
|
+
* [Get Invite](https://docs.medusajs.com/api/admin#invites_getinvitesid)
|
83
83
|
* API route.
|
84
84
|
*
|
85
85
|
* @param id - The invite's ID.
|
@@ -108,7 +108,7 @@ class Invite {
|
|
108
108
|
* })
|
109
109
|
* ```
|
110
110
|
*
|
111
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
111
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
112
112
|
*/
|
113
113
|
async retrieve(id, query, headers) {
|
114
114
|
return await this.client.fetch(`/admin/invites/${id}`, {
|
@@ -118,7 +118,7 @@ class Invite {
|
|
118
118
|
}
|
119
119
|
/**
|
120
120
|
* This method retrieves a paginated list of invites. It sends a request to the
|
121
|
-
* [List Invites](https://docs.medusajs.com/
|
121
|
+
* [List Invites](https://docs.medusajs.com/api/admin#invites_getinvites)
|
122
122
|
* API route.
|
123
123
|
*
|
124
124
|
* @param queryParams - Filters and pagination configurations.
|
@@ -161,7 +161,7 @@ class Invite {
|
|
161
161
|
* })
|
162
162
|
* ```
|
163
163
|
*
|
164
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
164
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
165
165
|
*/
|
166
166
|
async list(queryParams, headers) {
|
167
167
|
return await this.client.fetch(`/admin/invites`, {
|
@@ -171,7 +171,7 @@ class Invite {
|
|
171
171
|
}
|
172
172
|
/**
|
173
173
|
* This method refreshes the token of an invite. It sends a request to the
|
174
|
-
* [Refresh Invite Token](https://docs.medusajs.com/
|
174
|
+
* [Refresh Invite Token](https://docs.medusajs.com/api/admin#invites_postinvitesidresend)
|
175
175
|
* API route.
|
176
176
|
*
|
177
177
|
* @param id - The invite's ID.
|
@@ -192,7 +192,7 @@ class Invite {
|
|
192
192
|
}
|
193
193
|
/**
|
194
194
|
* This method deletes an invite. It sends a request to the
|
195
|
-
* [Delete Invite](https://docs.medusajs.com/
|
195
|
+
* [Delete Invite](https://docs.medusajs.com/api/admin#invites_deleteinvitesid)
|
196
196
|
* API route.
|
197
197
|
*
|
198
198
|
* @param id - The invite's ID.
|
@@ -10,8 +10,6 @@ export declare class PaymentCollection {
|
|
10
10
|
* @ignore
|
11
11
|
*/
|
12
12
|
constructor(client: Client);
|
13
|
-
list(query?: HttpTypes.AdminPaymentCollectionFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionsResponse>;
|
14
|
-
retrieve(id: string, query?: HttpTypes.AdminPaymentCollectionFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
|
15
13
|
create(body: HttpTypes.AdminCreatePaymentCollection, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
|
16
14
|
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDeletePaymentCollectionResponse>;
|
17
15
|
markAsPaid(id: string, body: HttpTypes.AdminMarkPaymentCollectionAsPaid, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"payment-collection.d.ts","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,
|
1
|
+
{"version":3,"file":"payment-collection.d.ts","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,UAAU,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}
|
@@ -8,18 +8,6 @@ class PaymentCollection {
|
|
8
8
|
constructor(client) {
|
9
9
|
this.client = client;
|
10
10
|
}
|
11
|
-
async list(query, headers) {
|
12
|
-
return await this.client.fetch(`/admin/payment-collections`, {
|
13
|
-
query,
|
14
|
-
headers,
|
15
|
-
});
|
16
|
-
}
|
17
|
-
async retrieve(id, query, headers) {
|
18
|
-
return await this.client.fetch(`/admin/payment-collections/${id}`, {
|
19
|
-
query,
|
20
|
-
headers,
|
21
|
-
});
|
22
|
-
}
|
23
11
|
async create(body, query, headers) {
|
24
12
|
return await this.client.fetch(`/admin/payment-collections`, {
|
25
13
|
method: "POST",
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"payment-collection.js","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,
|
1
|
+
{"version":3,"file":"payment-collection.js","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAA4C,EAC5C,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4BAA4B,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAAE,EAAE,EAClC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,EAAU,EACV,IAAgD,EAChD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAAE,eAAe,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAtDD,8CAsDC"}
|
package/dist/auth/index.d.ts
CHANGED
@@ -7,7 +7,7 @@ export declare class Auth {
|
|
7
7
|
constructor(client: Client, config: Config);
|
8
8
|
/**
|
9
9
|
* This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
|
10
|
-
* [Retrieve Registration Token API route](https://docs.medusajs.com/
|
10
|
+
* [Retrieve Registration Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_provider_register).
|
11
11
|
*
|
12
12
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
13
13
|
* @param method - The authentication provider to use. For example, `emailpass` or `google`.
|
@@ -30,10 +30,10 @@ export declare class Auth {
|
|
30
30
|
register: (actor: string, method: string, payload: HttpTypes.AdminSignUpWithEmailPassword) => Promise<string>;
|
31
31
|
/**
|
32
32
|
* This method retrieves the JWT authenticated token for an admin user, customer, or custom
|
33
|
-
* actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/
|
33
|
+
* actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_provider).
|
34
34
|
*
|
35
35
|
* If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
|
36
|
-
* [Set Authentication Session API route](https://docs.medusajs.com/
|
36
|
+
* [Set Authentication Session API route](https://docs.medusajs.com/api/admin#auth_postsession).
|
37
37
|
*
|
38
38
|
* Subsequent requests using the SDK will automatically have the necessary authentication headers / session
|
39
39
|
* set.
|
@@ -61,7 +61,7 @@ export declare class Auth {
|
|
61
61
|
}>;
|
62
62
|
/**
|
63
63
|
* This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
|
64
|
-
* It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/
|
64
|
+
* It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providercallback).
|
65
65
|
*
|
66
66
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
67
67
|
* @param method - The authentication provider to use. For example, `google`.
|
@@ -87,7 +87,7 @@ export declare class Auth {
|
|
87
87
|
callback: (actor: string, method: string, query?: Record<string, unknown>) => Promise<string>;
|
88
88
|
/**
|
89
89
|
* This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
|
90
|
-
* with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/
|
90
|
+
* with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth_postadminauthtokenrefresh).
|
91
91
|
*
|
92
92
|
* @returns The refreshed JWT authentication token.
|
93
93
|
*
|
@@ -100,7 +100,7 @@ export declare class Auth {
|
|
100
100
|
refresh: () => Promise<string>;
|
101
101
|
/**
|
102
102
|
* This method deletes the authentication session of the currently logged-in user to log them out.
|
103
|
-
* It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/
|
103
|
+
* It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth_deletesession).
|
104
104
|
*
|
105
105
|
* @example
|
106
106
|
* sdk.auth.logout()
|
@@ -111,11 +111,11 @@ export declare class Auth {
|
|
111
111
|
logout: () => Promise<void>;
|
112
112
|
/**
|
113
113
|
* This method requests a reset password token for an admin user, customer, or custom actor type.
|
114
|
-
* It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/
|
114
|
+
* It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword).
|
115
115
|
*
|
116
116
|
* To reset the password later using the token delivered to the user, use the {@link updateProvider} method.
|
117
117
|
*
|
118
|
-
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/
|
118
|
+
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
|
119
119
|
*
|
120
120
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
121
121
|
* @param provider - The authentication provider to use. For example, `emailpass`.
|
@@ -146,9 +146,9 @@ export declare class Auth {
|
|
146
146
|
* More specifically, use this method when updating the password of an admin user, customer, or
|
147
147
|
* custom actor type after requesting to reset their password with {@link resetPassword}.
|
148
148
|
*
|
149
|
-
* This method sends a request to [this API route](https://docs.medusajs.com/
|
149
|
+
* This method sends a request to [this API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate).
|
150
150
|
*
|
151
|
-
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/
|
151
|
+
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
|
152
152
|
*
|
153
153
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
154
154
|
* @param provider - The authentication provider to use. For example, `emailpass`.
|
package/dist/auth/index.js
CHANGED
@@ -5,7 +5,7 @@ class Auth {
|
|
5
5
|
constructor(client, config) {
|
6
6
|
/**
|
7
7
|
* This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
|
8
|
-
* [Retrieve Registration Token API route](https://docs.medusajs.com/
|
8
|
+
* [Retrieve Registration Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_provider_register).
|
9
9
|
*
|
10
10
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
11
11
|
* @param method - The authentication provider to use. For example, `emailpass` or `google`.
|
@@ -35,10 +35,10 @@ class Auth {
|
|
35
35
|
};
|
36
36
|
/**
|
37
37
|
* This method retrieves the JWT authenticated token for an admin user, customer, or custom
|
38
|
-
* actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/
|
38
|
+
* actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_provider).
|
39
39
|
*
|
40
40
|
* If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
|
41
|
-
* [Set Authentication Session API route](https://docs.medusajs.com/
|
41
|
+
* [Set Authentication Session API route](https://docs.medusajs.com/api/admin#auth_postsession).
|
42
42
|
*
|
43
43
|
* Subsequent requests using the SDK will automatically have the necessary authentication headers / session
|
44
44
|
* set.
|
@@ -77,7 +77,7 @@ class Auth {
|
|
77
77
|
};
|
78
78
|
/**
|
79
79
|
* This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
|
80
|
-
* It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/
|
80
|
+
* It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providercallback).
|
81
81
|
*
|
82
82
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
83
83
|
* @param method - The authentication provider to use. For example, `google`.
|
@@ -110,7 +110,7 @@ class Auth {
|
|
110
110
|
};
|
111
111
|
/**
|
112
112
|
* This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
|
113
|
-
* with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/
|
113
|
+
* with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/api/admin#auth_postadminauthtokenrefresh).
|
114
114
|
*
|
115
115
|
* @returns The refreshed JWT authentication token.
|
116
116
|
*
|
@@ -131,7 +131,7 @@ class Auth {
|
|
131
131
|
};
|
132
132
|
/**
|
133
133
|
* This method deletes the authentication session of the currently logged-in user to log them out.
|
134
|
-
* It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/
|
134
|
+
* It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/api/admin#auth_deletesession).
|
135
135
|
*
|
136
136
|
* @example
|
137
137
|
* sdk.auth.logout()
|
@@ -149,11 +149,11 @@ class Auth {
|
|
149
149
|
};
|
150
150
|
/**
|
151
151
|
* This method requests a reset password token for an admin user, customer, or custom actor type.
|
152
|
-
* It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/
|
152
|
+
* It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword).
|
153
153
|
*
|
154
154
|
* To reset the password later using the token delivered to the user, use the {@link updateProvider} method.
|
155
155
|
*
|
156
|
-
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/
|
156
|
+
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
|
157
157
|
*
|
158
158
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
159
159
|
* @param provider - The authentication provider to use. For example, `emailpass`.
|
@@ -184,9 +184,9 @@ class Auth {
|
|
184
184
|
* More specifically, use this method when updating the password of an admin user, customer, or
|
185
185
|
* custom actor type after requesting to reset their password with {@link resetPassword}.
|
186
186
|
*
|
187
|
-
* This method sends a request to [this API route](https://docs.medusajs.com/
|
187
|
+
* This method sends a request to [this API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate).
|
188
188
|
*
|
189
|
-
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/
|
189
|
+
* Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/resources/storefront-development/customers/reset-password).
|
190
190
|
*
|
191
191
|
* @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
|
192
192
|
* @param provider - The authentication provider to use. For example, `emailpass`.
|
@@ -12,7 +12,7 @@ export declare class ApiKey {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This methods retrieves a paginated list of API keys. It sends a request to the
|
15
|
-
* [List API Keys](https://docs.medusajs.com/
|
15
|
+
* [List API Keys](https://docs.medusajs.com/api/admin#api-keys_getapikeys) API route.
|
16
16
|
*
|
17
17
|
* @param queryParams - Filters and pagination configurations.
|
18
18
|
* @param headers - Headers to pass in the request.
|
@@ -54,11 +54,11 @@ export declare class ApiKey {
|
|
54
54
|
* })
|
55
55
|
* ```
|
56
56
|
*
|
57
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
57
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
58
58
|
*/
|
59
59
|
list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyListResponse>;
|
60
60
|
/**
|
61
|
-
* This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/
|
61
|
+
* This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeys)
|
62
62
|
* API route.
|
63
63
|
*
|
64
64
|
* @param body - The API key's details.
|
@@ -78,7 +78,7 @@ export declare class ApiKey {
|
|
78
78
|
create(body: HttpTypes.AdminCreateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
79
79
|
/**
|
80
80
|
* This method revokes an API key. It sends a request to the
|
81
|
-
* [Revoke API Key](https://docs.medusajs.com/
|
81
|
+
* [Revoke API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke) API route.
|
82
82
|
*
|
83
83
|
* @param id - The API key's ID.
|
84
84
|
* @param headers - Headers to pass in the request.
|
@@ -93,7 +93,7 @@ export declare class ApiKey {
|
|
93
93
|
revoke(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
94
94
|
/**
|
95
95
|
* This method retrieves an API key's details. It sends a request to the
|
96
|
-
* [Get API key](https://docs.medusajs.com/
|
96
|
+
* [Get API key](https://docs.medusajs.com/api/admin#api-keys_getapikeysid) API route.
|
97
97
|
*
|
98
98
|
* @param id - The API key's ID.
|
99
99
|
* @param headers - Headers to pass in the request.
|
@@ -108,7 +108,7 @@ export declare class ApiKey {
|
|
108
108
|
retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
109
109
|
/**
|
110
110
|
* This method updates an API key's details. It sends a request to the
|
111
|
-
* [Update API Key](https://docs.medusajs.com/
|
111
|
+
* [Update API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysid) API route.
|
112
112
|
*
|
113
113
|
* @param id - The API key's ID.
|
114
114
|
* @param body - The data to update in the API key.
|
@@ -127,7 +127,7 @@ export declare class ApiKey {
|
|
127
127
|
update(id: string, body: HttpTypes.AdminUpdateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
|
128
128
|
/**
|
129
129
|
* This method deletes an API key by its ID. It sends a request to the
|
130
|
-
* [Delete API Key](https://docs.medusajs.com/
|
130
|
+
* [Delete API Key](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid) API route.
|
131
131
|
*
|
132
132
|
* @param id - The API key's ID.
|
133
133
|
* @param headers - Headers to pass in the request.
|
@@ -142,7 +142,7 @@ export declare class ApiKey {
|
|
142
142
|
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyDeleteResponse>;
|
143
143
|
/**
|
144
144
|
* This method manages the sales channels associated with a publishable API key to either add
|
145
|
-
* or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/
|
145
|
+
* or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels)
|
146
146
|
* API route.
|
147
147
|
*
|
148
148
|
* @param id - The API key's ID.
|