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

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

@@ -10,11 +10,146 @@ export declare class Campaign {
      * @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/esm/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;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,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"}

package/dist/esm/admin/campaign.js

@@ -14,6 +14,38 @@ export class Campaign {
     constructor(client) {
         this.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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/campaigns/${id}`, {
@@ -22,6 +54,52 @@ export class Campaign {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/campaigns`, {
@@ -30,6 +108,22 @@ export class Campaign {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/campaigns`, {
@@ -39,6 +133,23 @@ export class Campaign {
             });
         });
     }
+    /**
+     * 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, payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/campaigns/${id}`, {
@@ -48,6 +159,20 @@ export class Campaign {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/campaigns/${id}`, {
@@ -56,6 +181,16 @@ export class 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, payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/campaigns/${id}/promotions`, {

package/dist/esm/admin/campaign.js.map

@@ -1 +1 @@
-{"version":3,"file":"campaign.js","sourceRoot":"","sources":["../../../src/admin/campaign.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAAwC,EACxC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,OAAsC,EACtC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,OAAsC,EACtC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,EAAU,EACV,OAAiC,EACjC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,aAAa,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"campaign.js","sourceRoot":"","sources":["../../../src/admin/campaign.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAAwC,EACxC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,OAAsC,EACtC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,EAAU,EACV,OAAsC,EACtC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;OASG;IACG,eAAe,CACnB,EAAU,EACV,OAAiC,EACjC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,aAAa,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;CACF"}