@medusajs/js-sdk 1.0.0-rc-20241016093905 → 1.0.0-rc-20241022152047

package/dist/admin/api-key.d.ts

@@ -2,14 +2,163 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class ApiKey {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
-    list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<HttpTypes.AdminApiKeyListResponse>>;
+    /**
+     * This methods retrieves a paginated list of API keys. It sends a request to the
+     * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of API keys.
+     *
+     * @example
+     * To retrieve the list of API keys:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list()
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each API key:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyListResponse>;
+    /**
+     * 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)
+     * API route.
+     *
+     * @param body - The API key's details.
+     * @param query - Configure the fields to retrieve in the created API key.
+     * @param headers - Headers to pass in the request
+     * @returns The created API key
+     *
+     * @example
+     * sdk.admin.apiKey.create({
+     *   title: "Development",
+     *   type: "publishable"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     create(body: HttpTypes.AdminCreateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method revokes an API key. It sends a request to the
+     * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.revoke("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     revoke(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method retrieves an API key's details. It sends a request to the
+     * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.retrieve("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method updates an API key's details. It sends a request to the
+     * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The data to update in the API key.
+     * @param query - Configure the fields to retrieve in the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.update("apk_123", {
+     *   title: "Development"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method deletes an API key by its ID. It sends a request to the
+     * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.apiKey.delete("apk_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyDeleteResponse>;
+    /**
+     * This method manages the sales channels associated with a publishable API key to either add
+     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
+     * API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The sales channels to add or remove from the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.batchSalesChannels("apk_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_321"]
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     batchSalesChannels(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
 }
 //# sourceMappingURL=api-key.d.ts.map

package/dist/admin/api-key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/admin/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAqB,MAAM,iBAAiB,CAAA;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAC7C,OAAO,CAAC,EAAE,aAAa;IAUnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAS5C,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/admin/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAC7C,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASlD;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/api-key.js

@@ -2,15 +2,82 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiKey = void 0;
 class ApiKey {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This methods retrieves a paginated list of API keys. It sends a request to the
+     * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of API keys.
+     *
+     * @example
+     * To retrieve the list of API keys:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list()
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each API key:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async list(queryParams, headers) {
         return await this.client.fetch(`/admin/api-keys`, {
             query: queryParams,
             headers,
         });
     }
+    /**
+     * 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)
+     * API route.
+     *
+     * @param body - The API key's details.
+     * @param query - Configure the fields to retrieve in the created API key.
+     * @param headers - Headers to pass in the request
+     * @returns The created API key
+     *
+     * @example
+     * sdk.admin.apiKey.create({
+     *   title: "Development",
+     *   type: "publishable"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/api-keys`, {
             method: "POST",
@@ -19,17 +86,63 @@ class ApiKey {
             query,
         });
     }
+    /**
+     * This method revokes an API key. It sends a request to the
+     * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.revoke("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     async revoke(id, headers) {
         return await this.client.fetch(`/admin/api-keys/${id}/revoke`, {
             method: "POST",
             headers,
         });
     }
+    /**
+     * This method retrieves an API key's details. It sends a request to the
+     * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.retrieve("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     async retrieve(id, headers) {
         return await this.client.fetch(`/admin/api-keys/${id}`, {
             headers,
         });
     }
+    /**
+     * This method updates an API key's details. It sends a request to the
+     * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The data to update in the API key.
+     * @param query - Configure the fields to retrieve in the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.update("apk_123", {
+     *   title: "Development"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/api-keys/${id}`, {
             method: "POST",
@@ -38,12 +151,45 @@ class ApiKey {
             query,
         });
     }
+    /**
+     * This method deletes an API key by its ID. It sends a request to the
+     * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.apiKey.delete("apk_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/api-keys/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method manages the sales channels associated with a publishable API key to either add
+     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
+     * API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The sales channels to add or remove from the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.batchSalesChannels("apk_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_321"]
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     async batchSalesChannels(id, body, headers) {
         return await this.client.fetch(`/admin/api-keys/${id}/sales-channels`, {
             method: "POST",

package/dist/admin/api-key.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/admin/api-key.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAEjB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE;YACnB,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;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,mBAAmB,EAAE,SAAS,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAuB;QAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;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,mBAAmB,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,IAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,iBAAiB,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA9FD,wBA8FC"}
+{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/admin/api-key.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE;YACnB,KAAK,EAAE,WAAW;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,SAAS,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAuB;QAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,IAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,iBAAiB,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAnPD,wBAmPC"}

package/dist/admin/campaign.d.ts

@@ -2,13 +2,154 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class Campaign {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
+    /**
+     * This method retrieves a campaign by its ID. It sends a request to the
+     * [Get Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaignsid) API route.
+     *
+     * @param id - The campaign's ID.
+     * @param query - Configure the fields to retrieve in the campaign.
+     * @param headers - Headers to pass in the request
+     * @returns The campaign's details.
+     *
+     * @example
+     * To retrieve a campaign by its ID:
+     *
+     * ```ts
+     * sdk.admin.campaign.retrieve("procamp_123")
+     * .then(({ campaign }) => {
+     *   console.log(campaign)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.campaign.retrieve("procamp_123", {
+     *   fields: "id,*budget"
+     * })
+     * .then(({ campaign }) => {
+     *   console.log(campaign)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminGetCampaignParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
+    /**
+     * This method retrieves a paginated list of campaigns. It sends a request to the
+     * [List Campaigns](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaigns) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of campaigns.
+     *
+     * @example
+     * To retrieve the list of campaigns:
+     *
+     * ```ts
+     * sdk.admin.campaign.list()
+     * .then(({ campaigns, count, limit, offset }) => {
+     *   console.log(campaigns)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.campaign.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ campaigns, count, limit, offset }) => {
+     *   console.log(campaigns)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each campaign:
+     *
+     * ```ts
+     * sdk.admin.campaign.list({
+     *   fields: "id,*budget"
+     * })
+     * .then(({ campaigns, count, limit, offset }) => {
+     *   console.log(campaigns)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminGetCampaignsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignListResponse>;
+    /**
+     * This method creates a campaign. It sends a request to the
+     * [Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaigns) API route.
+     *
+     * @param payload - The details of the campaign to create.
+     * @param headers - Headers to pass in the request
+     * @returns The campaign's details.
+     *
+     * @example
+     * sdk.admin.campaign.create({
+     *   name: "Summer Campaign"
+     * })
+     * .then(({ campaign }) => {
+     *   console.log(campaign)
+     * })
+     */
     create(payload: HttpTypes.AdminCreateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
+    /**
+     * This method updates a campaign. It sends a request to the
+     * [Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsid) API route.
+     *
+     * @param id - The campaign's ID.
+     * @param payload - The data to update in the campaign.
+     * @param headers - Headers to pass in the request
+     * @returns The campaign's details.
+     *
+     * @example
+     * sdk.admin.campaign.update("procamp_123", {
+     *   name: "Summer Campaign"
+     * })
+     * .then(({ campaign }) => {
+     *   console.log(campaign)
+     * })
+     */
     update(id: string, payload: HttpTypes.AdminUpdateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
+    /**
+     * This method deletes a campaign by its ID. It sends a request to the
+     * [Delete Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_deletecampaignsid) API route.
+     *
+     * @param id - The campaign's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.campaign.delete("procamp_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"campaign">>;
+    /**
+     * This method manages the promotions of a campaign to either add or remove the association between them.
+     * It sends a request to the [Manage Promotions](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsidpromotions)
+     * API route.
+     *
+     * @param id - The campaign's ID.
+     * @param payload - The promotions to add or remove associations to them.
+     * @param headers - Headers to pass in the request
+     * @returns The campaign's details.
+     */
     batchPromotions(id: string, payload: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
 }
 //# sourceMappingURL=campaign.d.ts.map

package/dist/admin/campaign.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"campaign.d.ts","sourceRoot":"","sources":["../../src/admin/campaign.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;IAWnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CACV,OAAO,EAAE,SAAS,CAAC,mBAAmB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,SAAS,CAAC,mBAAmB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,SAAS,CAAC,cAAc,EACjC,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"campaign.d.ts","sourceRoot":"","sources":["../../src/admin/campaign.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,OAAO,EAAE,SAAS,CAAC,mBAAmB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,SAAS,CAAC,mBAAmB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;OASG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,SAAS,CAAC,cAAc,EACjC,OAAO,CAAC,EAAE,aAAa;CAW1B"}