@medusajs/js-sdk 2.0.0 → 2.0.1-preview-20241025120203

Sign up to get free protection for your applications and to get access to all the features.
Files changed (101) hide show
  1. package/dist/admin/api-key.d.ts +8 -8
  2. package/dist/admin/api-key.js +8 -8
  3. package/dist/admin/campaign.d.ts +8 -8
  4. package/dist/admin/campaign.js +8 -8
  5. package/dist/admin/claim.d.ts +22 -22
  6. package/dist/admin/claim.js +22 -22
  7. package/dist/admin/currency.d.ts +4 -4
  8. package/dist/admin/currency.js +4 -4
  9. package/dist/admin/customer-group.d.ts +8 -8
  10. package/dist/admin/customer-group.js +8 -8
  11. package/dist/admin/customer.d.ts +27 -7
  12. package/dist/admin/customer.d.ts.map +1 -1
  13. package/dist/admin/customer.js +33 -7
  14. package/dist/admin/customer.js.map +1 -1
  15. package/dist/admin/exchange.d.ts +21 -21
  16. package/dist/admin/exchange.js +21 -21
  17. package/dist/admin/fulfillment-provider.d.ts +2 -2
  18. package/dist/admin/fulfillment-provider.js +2 -2
  19. package/dist/admin/fulfillment-set.d.ts +6 -6
  20. package/dist/admin/fulfillment-set.js +6 -6
  21. package/dist/admin/fulfillment.d.ts +3 -3
  22. package/dist/admin/fulfillment.js +3 -3
  23. package/dist/admin/inventory-item.d.ts +12 -12
  24. package/dist/admin/inventory-item.js +12 -12
  25. package/dist/admin/invite.d.ts +8 -8
  26. package/dist/admin/invite.js +8 -8
  27. package/dist/admin/payment-collection.d.ts +0 -2
  28. package/dist/admin/payment-collection.d.ts.map +1 -1
  29. package/dist/admin/payment-collection.js +0 -12
  30. package/dist/admin/payment-collection.js.map +1 -1
  31. package/dist/admin/price-list.d.ts +195 -1
  32. package/dist/admin/price-list.d.ts.map +1 -1
  33. package/dist/admin/price-list.js +194 -0
  34. package/dist/admin/price-list.js.map +1 -1
  35. package/dist/admin/price-preference.d.ts +133 -0
  36. package/dist/admin/price-preference.d.ts.map +1 -1
  37. package/dist/admin/price-preference.js +133 -0
  38. package/dist/admin/price-preference.js.map +1 -1
  39. package/dist/admin/product-category.d.ts +150 -0
  40. package/dist/admin/product-category.d.ts.map +1 -1
  41. package/dist/admin/product-category.js +150 -0
  42. package/dist/admin/product-category.js.map +1 -1
  43. package/dist/admin/product-collection.d.ts +149 -0
  44. package/dist/admin/product-collection.d.ts.map +1 -1
  45. package/dist/admin/product-collection.js +149 -0
  46. package/dist/admin/product-collection.js.map +1 -1
  47. package/dist/auth/index.d.ts +10 -10
  48. package/dist/auth/index.js +10 -10
  49. package/dist/esm/admin/api-key.d.ts +8 -8
  50. package/dist/esm/admin/api-key.js +8 -8
  51. package/dist/esm/admin/campaign.d.ts +8 -8
  52. package/dist/esm/admin/campaign.js +8 -8
  53. package/dist/esm/admin/claim.d.ts +22 -22
  54. package/dist/esm/admin/claim.js +22 -22
  55. package/dist/esm/admin/currency.d.ts +4 -4
  56. package/dist/esm/admin/currency.js +4 -4
  57. package/dist/esm/admin/customer-group.d.ts +8 -8
  58. package/dist/esm/admin/customer-group.js +8 -8
  59. package/dist/esm/admin/customer.d.ts +27 -7
  60. package/dist/esm/admin/customer.d.ts.map +1 -1
  61. package/dist/esm/admin/customer.js +35 -7
  62. package/dist/esm/admin/customer.js.map +1 -1
  63. package/dist/esm/admin/exchange.d.ts +21 -21
  64. package/dist/esm/admin/exchange.js +21 -21
  65. package/dist/esm/admin/fulfillment-provider.d.ts +2 -2
  66. package/dist/esm/admin/fulfillment-provider.js +2 -2
  67. package/dist/esm/admin/fulfillment-set.d.ts +6 -6
  68. package/dist/esm/admin/fulfillment-set.js +6 -6
  69. package/dist/esm/admin/fulfillment.d.ts +3 -3
  70. package/dist/esm/admin/fulfillment.js +3 -3
  71. package/dist/esm/admin/inventory-item.d.ts +12 -12
  72. package/dist/esm/admin/inventory-item.js +12 -12
  73. package/dist/esm/admin/invite.d.ts +8 -8
  74. package/dist/esm/admin/invite.js +8 -8
  75. package/dist/esm/admin/payment-collection.d.ts +0 -2
  76. package/dist/esm/admin/payment-collection.d.ts.map +1 -1
  77. package/dist/esm/admin/payment-collection.js +0 -16
  78. package/dist/esm/admin/payment-collection.js.map +1 -1
  79. package/dist/esm/admin/price-list.d.ts +195 -1
  80. package/dist/esm/admin/price-list.d.ts.map +1 -1
  81. package/dist/esm/admin/price-list.js +194 -0
  82. package/dist/esm/admin/price-list.js.map +1 -1
  83. package/dist/esm/admin/price-preference.d.ts +133 -0
  84. package/dist/esm/admin/price-preference.d.ts.map +1 -1
  85. package/dist/esm/admin/price-preference.js +133 -0
  86. package/dist/esm/admin/price-preference.js.map +1 -1
  87. package/dist/esm/admin/product-category.d.ts +150 -0
  88. package/dist/esm/admin/product-category.d.ts.map +1 -1
  89. package/dist/esm/admin/product-category.js +150 -0
  90. package/dist/esm/admin/product-category.js.map +1 -1
  91. package/dist/esm/admin/product-collection.d.ts +149 -0
  92. package/dist/esm/admin/product-collection.d.ts.map +1 -1
  93. package/dist/esm/admin/product-collection.js +149 -0
  94. package/dist/esm/admin/product-collection.js.map +1 -1
  95. package/dist/esm/auth/index.d.ts +10 -10
  96. package/dist/esm/auth/index.js +10 -10
  97. package/dist/esm/store/index.d.ts +73 -73
  98. package/dist/esm/store/index.js +73 -73
  99. package/dist/store/index.d.ts +73 -73
  100. package/dist/store/index.js +73 -73
  101. package/package.json +2 -2
@@ -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/v2/api/admin#api-keys_getapikeys) API route.
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/v2/api/store#select-fields-and-relations).
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/v2/api/admin#api-keys_postapikeys)
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/v2/api/admin#api-keys_postapikeysidrevoke) API route.
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/v2/api/admin#api-keys_getapikeysid) API route.
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/v2/api/admin#api-keys_postapikeysid) API route.
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/v2/api/admin#api-keys_deleteapikeysid) API route.
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/v2/api/admin#api-keys_postapikeysidsaleschannels)
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.
@@ -10,7 +10,7 @@ class ApiKey {
10
10
  }
11
11
  /**
12
12
  * This methods retrieves a paginated list of API keys. It sends a request to the
13
- * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
13
+ * [List API Keys](https://docs.medusajs.com/api/admin#api-keys_getapikeys) API route.
14
14
  *
15
15
  * @param queryParams - Filters and pagination configurations.
16
16
  * @param headers - Headers to pass in the request.
@@ -52,7 +52,7 @@ class ApiKey {
52
52
  * })
53
53
  * ```
54
54
  *
55
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
55
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
56
56
  */
57
57
  async list(queryParams, headers) {
58
58
  return await this.client.fetch(`/admin/api-keys`, {
@@ -61,7 +61,7 @@ class ApiKey {
61
61
  });
62
62
  }
63
63
  /**
64
- * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeys)
64
+ * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeys)
65
65
  * API route.
66
66
  *
67
67
  * @param body - The API key's details.
@@ -88,7 +88,7 @@ class ApiKey {
88
88
  }
89
89
  /**
90
90
  * This method revokes an API key. It sends a request to the
91
- * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
91
+ * [Revoke API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke) API route.
92
92
  *
93
93
  * @param id - The API key's ID.
94
94
  * @param headers - Headers to pass in the request.
@@ -108,7 +108,7 @@ class ApiKey {
108
108
  }
109
109
  /**
110
110
  * This method retrieves an API key's details. It sends a request to the
111
- * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
111
+ * [Get API key](https://docs.medusajs.com/api/admin#api-keys_getapikeysid) API route.
112
112
  *
113
113
  * @param id - The API key's ID.
114
114
  * @param headers - Headers to pass in the request.
@@ -127,7 +127,7 @@ class ApiKey {
127
127
  }
128
128
  /**
129
129
  * This method updates an API key's details. It sends a request to the
130
- * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
130
+ * [Update API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysid) API route.
131
131
  *
132
132
  * @param id - The API key's ID.
133
133
  * @param body - The data to update in the API key.
@@ -153,7 +153,7 @@ class ApiKey {
153
153
  }
154
154
  /**
155
155
  * This method deletes an API key by its ID. It sends a request to the
156
- * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
156
+ * [Delete API Key](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid) API route.
157
157
  *
158
158
  * @param id - The API key's ID.
159
159
  * @param headers - Headers to pass in the request.
@@ -173,7 +173,7 @@ class ApiKey {
173
173
  }
174
174
  /**
175
175
  * This method manages the sales channels associated with a publishable API key to either add
176
- * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
176
+ * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels)
177
177
  * API route.
178
178
  *
179
179
  * @param id - The API key's ID.
@@ -12,7 +12,7 @@ export declare class Campaign {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a campaign by its ID. It sends a request to the
15
- * [Get Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaignsid) API route.
15
+ * [Get Campaign](https://docs.medusajs.com/api/admin#campaigns_getcampaignsid) API route.
16
16
  *
17
17
  * @param id - The campaign's ID.
18
18
  * @param query - Configure the fields to retrieve in the campaign.
@@ -40,12 +40,12 @@ export declare class Campaign {
40
40
  * })
41
41
  * ```
42
42
  *
43
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
43
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
44
44
  */
45
45
  retrieve(id: string, query?: HttpTypes.AdminGetCampaignParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
46
46
  /**
47
47
  * This method retrieves a paginated list of campaigns. It sends a request to the
48
- * [List Campaigns](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaigns) API route.
48
+ * [List Campaigns](https://docs.medusajs.com/api/admin#campaigns_getcampaigns) API route.
49
49
  *
50
50
  * @param query - Filters and pagination configurations.
51
51
  * @param headers - Headers to pass in the request.
@@ -87,12 +87,12 @@ export declare class Campaign {
87
87
  * })
88
88
  * ```
89
89
  *
90
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
90
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
91
91
  */
92
92
  list(query?: HttpTypes.AdminGetCampaignsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignListResponse>;
93
93
  /**
94
94
  * This method creates a campaign. It sends a request to the
95
- * [Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaigns) API route.
95
+ * [Create Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaigns) API route.
96
96
  *
97
97
  * @param payload - The details of the campaign to create.
98
98
  * @param headers - Headers to pass in the request
@@ -109,7 +109,7 @@ export declare class Campaign {
109
109
  create(payload: HttpTypes.AdminCreateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
110
110
  /**
111
111
  * This method updates a campaign. It sends a request to the
112
- * [Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsid) API route.
112
+ * [Update Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaignsid) API route.
113
113
  *
114
114
  * @param id - The campaign's ID.
115
115
  * @param payload - The data to update in the campaign.
@@ -127,7 +127,7 @@ export declare class Campaign {
127
127
  update(id: string, payload: HttpTypes.AdminUpdateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
128
128
  /**
129
129
  * This method deletes a campaign by its ID. It sends a request to the
130
- * [Delete Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_deletecampaignsid) API route.
130
+ * [Delete Campaign](https://docs.medusajs.com/api/admin#campaigns_deletecampaignsid) API route.
131
131
  *
132
132
  * @param id - The campaign's ID.
133
133
  * @param headers - Headers to pass in the request
@@ -142,7 +142,7 @@ export declare class Campaign {
142
142
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"campaign">>;
143
143
  /**
144
144
  * This method manages the promotions of a campaign to either add or remove the association between them.
145
- * It sends a request to the [Manage Promotions](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsidpromotions)
145
+ * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin#campaigns_postcampaignsidpromotions)
146
146
  * API route.
147
147
  *
148
148
  * @param id - The campaign's ID.
@@ -10,7 +10,7 @@ class Campaign {
10
10
  }
11
11
  /**
12
12
  * This method retrieves a campaign by its ID. It sends a request to the
13
- * [Get Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaignsid) API route.
13
+ * [Get Campaign](https://docs.medusajs.com/api/admin#campaigns_getcampaignsid) API route.
14
14
  *
15
15
  * @param id - The campaign's ID.
16
16
  * @param query - Configure the fields to retrieve in the campaign.
@@ -38,7 +38,7 @@ class Campaign {
38
38
  * })
39
39
  * ```
40
40
  *
41
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
41
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
42
42
  */
43
43
  async retrieve(id, query, headers) {
44
44
  return await this.client.fetch(`/admin/campaigns/${id}`, {
@@ -48,7 +48,7 @@ class Campaign {
48
48
  }
49
49
  /**
50
50
  * This method retrieves a paginated list of campaigns. It sends a request to the
51
- * [List Campaigns](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaigns) API route.
51
+ * [List Campaigns](https://docs.medusajs.com/api/admin#campaigns_getcampaigns) API route.
52
52
  *
53
53
  * @param query - Filters and pagination configurations.
54
54
  * @param headers - Headers to pass in the request.
@@ -90,7 +90,7 @@ class Campaign {
90
90
  * })
91
91
  * ```
92
92
  *
93
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
93
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
94
94
  */
95
95
  async list(query, headers) {
96
96
  return await this.client.fetch(`/admin/campaigns`, {
@@ -100,7 +100,7 @@ class Campaign {
100
100
  }
101
101
  /**
102
102
  * This method creates a campaign. It sends a request to the
103
- * [Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaigns) API route.
103
+ * [Create Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaigns) API route.
104
104
  *
105
105
  * @param payload - The details of the campaign to create.
106
106
  * @param headers - Headers to pass in the request
@@ -123,7 +123,7 @@ class Campaign {
123
123
  }
124
124
  /**
125
125
  * This method updates a campaign. It sends a request to the
126
- * [Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsid) API route.
126
+ * [Update Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaignsid) API route.
127
127
  *
128
128
  * @param id - The campaign's ID.
129
129
  * @param payload - The data to update in the campaign.
@@ -147,7 +147,7 @@ class Campaign {
147
147
  }
148
148
  /**
149
149
  * This method deletes a campaign by its ID. It sends a request to the
150
- * [Delete Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_deletecampaignsid) API route.
150
+ * [Delete Campaign](https://docs.medusajs.com/api/admin#campaigns_deletecampaignsid) API route.
151
151
  *
152
152
  * @param id - The campaign's ID.
153
153
  * @param headers - Headers to pass in the request
@@ -167,7 +167,7 @@ class Campaign {
167
167
  }
168
168
  /**
169
169
  * This method manages the promotions of a campaign to either add or remove the association between them.
170
- * It sends a request to the [Manage Promotions](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsidpromotions)
170
+ * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin#campaigns_postcampaignsidpromotions)
171
171
  * API route.
172
172
  *
173
173
  * @param id - The campaign's ID.
@@ -12,7 +12,7 @@ export declare class Claim {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a paginated list of claims. It sends a request to the
15
- * [List Claims](https://docs.medusajs.com/v2/api/admin#claims_getclaims) API route.
15
+ * [List Claims](https://docs.medusajs.com/api/admin#claims_getclaims) API route.
16
16
  *
17
17
  * @param query - Filters and pagination configurations.
18
18
  * @param headers - Headers to pass in the request.
@@ -54,12 +54,12 @@ export declare class Claim {
54
54
  * })
55
55
  * ```
56
56
  *
57
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
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(query?: HttpTypes.AdminClaimListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimListResponse>;
60
60
  /**
61
61
  * This method retrieves a claim. It sends a request to the
62
- * [Get Claim](https://docs.medusajs.com/v2/api/admin#claims_getclaimsid) API route.
62
+ * [Get Claim](https://docs.medusajs.com/api/admin#claims_getclaimsid) API route.
63
63
  *
64
64
  * @param id - The claim's ID.
65
65
  * @param query - Configure the fields to retrieve in the claim.
@@ -87,12 +87,12 @@ export declare class Claim {
87
87
  * })
88
88
  * ```
89
89
  *
90
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
90
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
91
91
  */
92
92
  retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimResponse>;
93
93
  /**
94
94
  * This method creates a claim. It sends a request to the
95
- * [Create Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaims) API route.
95
+ * [Create Claim](https://docs.medusajs.com/api/admin#claims_postclaims) API route.
96
96
  *
97
97
  * @param body - The claim's details.
98
98
  * @param query - Configure the fields to retrieve in the claim.
@@ -111,7 +111,7 @@ export declare class Claim {
111
111
  create(body: HttpTypes.AdminCreateClaim, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimOrderResponse>;
112
112
  /**
113
113
  * This method cancels a claim. It sends a request to the
114
- * [Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidcancel) API route.
114
+ * [Cancel Claim](https://docs.medusajs.com/api/admin#claims_postclaimsidcancel) API route.
115
115
  *
116
116
  * @param id - The claim's ID.
117
117
  * @param query - Configure the fields to retrieve in the claim.
@@ -127,7 +127,7 @@ export declare class Claim {
127
127
  cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimResponse>;
128
128
  /**
129
129
  * This method adds items to the claim. It sends a request to the
130
- * [Add Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitems) API route.
130
+ * [Add Items](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitems) API route.
131
131
  *
132
132
  * @param id - The ID of the claim to add the items to.
133
133
  * @param body - The items' details.
@@ -151,7 +151,7 @@ export declare class Claim {
151
151
  addItems(id: string, body: HttpTypes.AdminAddClaimItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
152
152
  /**
153
153
  * This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It
154
- * sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
154
+ * sends a request to the [Update Claim Item](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
155
155
  *
156
156
  * Every item has an `actions` property, whose value is an array of actions.
157
157
  * You can check the action's name using its `action` property, and use the value of the `id` property.
@@ -178,7 +178,7 @@ export declare class Claim {
178
178
  updateItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
179
179
  /**
180
180
  * This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
181
- * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidclaimitemsaction_id)
181
+ * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidclaimitemsaction_id)
182
182
  * API route.
183
183
  *
184
184
  * Every item has an `actions` property, whose value is an array of actions.
@@ -203,7 +203,7 @@ export declare class Claim {
203
203
  /**
204
204
  * This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action.
205
205
  *
206
- * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditems)
206
+ * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditems)
207
207
  * API route.
208
208
  *
209
209
  * @param id - The ID of the claim to add the inbound items to.
@@ -231,7 +231,7 @@ export declare class Claim {
231
231
  addInboundItems(id: string, body: HttpTypes.AdminAddClaimInboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
232
232
  /**
233
233
  * This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action.
234
- * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditemsaction_id)
234
+ * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditemsaction_id)
235
235
  * API route.
236
236
  *
237
237
  * Every item has an `actions` property, whose value is an array of actions.
@@ -259,7 +259,7 @@ export declare class Claim {
259
259
  updateInboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimInboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
260
260
  /**
261
261
  * This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action.
262
- * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinbounditemsaction_id)
262
+ * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinbounditemsaction_id)
263
263
  * API route.
264
264
  *
265
265
  * Every item has an `actions` property, whose value is an array of actions.
@@ -285,7 +285,7 @@ export declare class Claim {
285
285
  * This method adds an inbound (or return) shipping method to a claim.
286
286
  * The inbound shipping method will have a `SHIPPING_ADD` action.
287
287
  *
288
- * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethod)
288
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethod)
289
289
  * API route.
290
290
  *
291
291
  * @param id - The claim's ID.
@@ -309,7 +309,7 @@ export declare class Claim {
309
309
  addInboundShipping(id: string, body: HttpTypes.AdminClaimAddInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
310
310
  /**
311
311
  * This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
312
- * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
312
+ * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
313
313
  * API route.
314
314
  *
315
315
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -337,7 +337,7 @@ export declare class Claim {
337
337
  updateInboundShipping(id: string, actionId: string, body: HttpTypes.AdminClaimUpdateInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
338
338
  /**
339
339
  * This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
340
- * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
340
+ * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
341
341
  * API route.
342
342
  *
343
343
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -361,7 +361,7 @@ export declare class Claim {
361
361
  deleteInboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
362
362
  /**
363
363
  * This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.
364
- * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditems)
364
+ * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditems)
365
365
  * API route.
366
366
  *
367
367
  * @param id - The ID of the claim to add the outbound items to.
@@ -387,7 +387,7 @@ export declare class Claim {
387
387
  addOutboundItems(id: string, body: HttpTypes.AdminAddClaimOutboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
388
388
  /**
389
389
  * This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action.
390
- * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditemsaction_id)
390
+ * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditemsaction_id)
391
391
  * API route.
392
392
  *
393
393
  * Every item has an `actions` property, whose value is an array of actions.
@@ -415,7 +415,7 @@ export declare class Claim {
415
415
  updateOutboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimOutboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
416
416
  /**
417
417
  * This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action.
418
- * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
418
+ * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
419
419
  * API route.
420
420
  *
421
421
  * Every item has an `actions` property, whose value is an array of actions.
@@ -442,7 +442,7 @@ export declare class Claim {
442
442
  * The outbound shipping method will have a `SHIPPING_ADD` action.
443
443
  *
444
444
  * This method sends a request to the
445
- * [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethod)
445
+ * [Add Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethod)
446
446
  * API route.
447
447
  *
448
448
  * @param id - The claim's ID.
@@ -466,7 +466,7 @@ export declare class Claim {
466
466
  addOutboundShipping(id: string, body: HttpTypes.AdminClaimAddOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
467
467
  /**
468
468
  * This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action.
469
- * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
469
+ * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
470
470
  * API route.
471
471
  *
472
472
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -516,7 +516,7 @@ export declare class Claim {
516
516
  deleteOutboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
517
517
  /**
518
518
  * This method confirms a claim request, applying its changes on the associated order.
519
- * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidrequest)
519
+ * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/api/admin#claims_postclaimsidrequest)
520
520
  * API route.
521
521
  *
522
522
  * @param id - The claim's ID.
@@ -537,7 +537,7 @@ export declare class Claim {
537
537
  request(id: string, body: HttpTypes.AdminRequestClaim, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimRequestResponse>;
538
538
  /**
539
539
  * This method cancels a requested claim. It sends a request to the
540
- * [Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidrequest)
540
+ * [Cancel Claim Request](https://docs.medusajs.com/api/admin#claims_deleteclaimsidrequest)
541
541
  * API route.
542
542
  *
543
543
  * @param id - The claim's ID.