@medusajs/js-sdk 2.0.0-preview-20241022100028 → 2.0.0-rc-20241022183311

package/dist/admin/invite.d.ts

@@ -10,23 +10,178 @@ export declare class Invite {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method accepts an invite. It requires sending a previous request to
+     * the {@link Auth.register}.
+     *
+     * This method sends a request to the [Accept Invite]
+     * (https://docs.medusajs.com/v2/api/admin#invites_postinvitesaccept)
+     * API route.
+     *
+     * @param input - The details of the user to create.
+     * @param query - Configure the fields to retrieve in the user.
+     * @param headers - Headers to pass in the request
+     * @returns The user's details.
+     *
+     * @example
+     * const token = await sdk.auth.register("user", "emailpass", {
+     *   email: "user@gmail.com",
+     *   password: "supersecret"
+     * })
+     *
+     * sdk.admin.invite.accept(
+     *   {
+     *     email: "user@gmail.com",
+     *     first_name: "John",
+     *     last_name: "Smith",
+     *     invite_token: "12345..."
+     *   },
+     *   {
+     *     Authorization: `Bearer ${token}`
+     *   }
+     * )
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     */
     accept(input: HttpTypes.AdminAcceptInvite & {
+        /**
+         * The invite's token.
+         */
         invite_token: string;
-    }, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        user: HttpTypes.AdminUserResponse;
-    }>;
-    create(body: HttpTypes.AdminCreateInvite, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        invite: HttpTypes.AdminInviteResponse;
-    }>;
-    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        invite: HttpTypes.AdminInviteResponse;
-    }>;
-    list(queryParams?: FindParams, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<{
-        invites: HttpTypes.AdminInviteResponse[];
-    }>>;
-    resend(id: string, headers?: ClientHeaders): Promise<{
-        invite: HttpTypes.AdminInviteResponse;
-    }>;
+    }, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminAcceptInviteResponse>;
+    /**
+     * This method creates an invite. It sends a request to the
+     * [Create Invite](https://docs.medusajs.com/v2/api/admin#invites_postinvites)
+     * API route.
+     *
+     * @param body - The invite's details.
+     * @param query - Configure the fields to retrieve in the invite.
+     * @param headers - Headers to pass in the request
+     * @returns The invite's details.
+     *
+     * @example
+     * sdk.admin.invite.create({
+     *   email: "user@gmail.com",
+     * })
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     */
+    create(body: HttpTypes.AdminCreateInvite, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
+    /**
+     * This method retrieves an invite by its ID. It sends a request to the
+     * [Get Invite](https://docs.medusajs.com/v2/api/admin#invites_getinvitesid)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param query - Configure the fields to retrieve in the invite.
+     * @param headers - Headers to pass in the request
+     * @returns The invite's details.
+     *
+     * @example
+     * To retrieve an invite its ID:
+     *
+     * ```ts
+     * sdk.admin.invite.retrieve("invite_123")
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.invite.retrieve("invite_123", {
+     *   fields: "id,email"
+     * })
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     * ```
+     *
+     * 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?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
+    /**
+     * This method retrieves a paginated list of invites. It sends a request to the
+     * [List Invites](https://docs.medusajs.com/v2/api/admin#invites_getinvites)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of invites.
+     *
+     * @example
+     * To retrieve the list of invites:
+     *
+     * ```ts
+     * sdk.admin.invite.list()
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * 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.invite.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each invite:
+     *
+     * ```ts
+     * sdk.admin.invite.list({
+     *   fields: "id,email"
+     * })
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    list(queryParams?: FindParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteListResponse>;
+    /**
+     * This method refreshes the token of an invite. It sends a request to the
+     * [Refresh Invite Token](https://docs.medusajs.com/v2/api/admin#invites_postinvitesidresend)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The invite's details.
+     *
+     * @example
+     * sdk.admin.invite.resend("invite_123")
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     */
+    resend(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
+    /**
+     * This method deletes an invite. It sends a request to the
+     * [Delete Invite](https://docs.medusajs.com/v2/api/admin#invites_deleteinvitesid)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.invite.delete("invite_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteDeleteResponse>;
 }
 //# sourceMappingURL=invite.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"invite.d.ts","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EAET,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,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;IAIpB,MAAM,CACV,KAAK,EAAE,SAAS,CAAC,iBAAiB,GAAG;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,EAC7D,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;cAGgB,SAAS,CAAC,iBAAiB;;IAW9D,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;gBAEkB,SAAS,CAAC,mBAAmB;;IAWlE,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;gBAC7B,SAAS,CAAC,mBAAmB;;IASlE,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa;iBAE3B,SAAS,CAAC,mBAAmB,EAAE;;IAO1D,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;gBACL,SAAS,CAAC,mBAAmB;;IASlE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"invite.d.ts","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,MAAM,CACV,KAAK,EAAE,SAAS,CAAC,iBAAiB,GAAG;QACnC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;KACrB,EACD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAczB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa;IAS5D;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}

package/dist/admin/invite.js

@@ -8,6 +8,40 @@ class Invite {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method accepts an invite. It requires sending a previous request to
+     * the {@link Auth.register}.
+     *
+     * This method sends a request to the [Accept Invite]
+     * (https://docs.medusajs.com/v2/api/admin#invites_postinvitesaccept)
+     * API route.
+     *
+     * @param input - The details of the user to create.
+     * @param query - Configure the fields to retrieve in the user.
+     * @param headers - Headers to pass in the request
+     * @returns The user's details.
+     *
+     * @example
+     * const token = await sdk.auth.register("user", "emailpass", {
+     *   email: "user@gmail.com",
+     *   password: "supersecret"
+     * })
+     *
+     * sdk.admin.invite.accept(
+     *   {
+     *     email: "user@gmail.com",
+     *     first_name: "John",
+     *     last_name: "Smith",
+     *     invite_token: "12345..."
+     *   },
+     *   {
+     *     Authorization: `Bearer ${token}`
+     *   }
+     * )
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     */
     async accept(input, query, headers) {
         const { invite_token, ...rest } = input;
         return await this.client.fetch(`/admin/invites/accept?token=${input.invite_token}`, {
@@ -17,6 +51,24 @@ class Invite {
             query,
         });
     }
+    /**
+     * This method creates an invite. It sends a request to the
+     * [Create Invite](https://docs.medusajs.com/v2/api/admin#invites_postinvites)
+     * API route.
+     *
+     * @param body - The invite's details.
+     * @param query - Configure the fields to retrieve in the invite.
+     * @param headers - Headers to pass in the request
+     * @returns The invite's details.
+     *
+     * @example
+     * sdk.admin.invite.create({
+     *   email: "user@gmail.com",
+     * })
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/invites`, {
             method: "POST",
@@ -25,24 +77,134 @@ class Invite {
             query,
         });
     }
+    /**
+     * This method retrieves an invite by its ID. It sends a request to the
+     * [Get Invite](https://docs.medusajs.com/v2/api/admin#invites_getinvitesid)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param query - Configure the fields to retrieve in the invite.
+     * @param headers - Headers to pass in the request
+     * @returns The invite's details.
+     *
+     * @example
+     * To retrieve an invite its ID:
+     *
+     * ```ts
+     * sdk.admin.invite.retrieve("invite_123")
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.invite.retrieve("invite_123", {
+     *   fields: "id,email"
+     * })
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/invites/${id}`, {
             headers,
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of invites. It sends a request to the
+     * [List Invites](https://docs.medusajs.com/v2/api/admin#invites_getinvites)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of invites.
+     *
+     * @example
+     * To retrieve the list of invites:
+     *
+     * ```ts
+     * sdk.admin.invite.list()
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * 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.invite.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each invite:
+     *
+     * ```ts
+     * sdk.admin.invite.list({
+     *   fields: "id,email"
+     * })
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * 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/invites`, {
             headers,
             query: queryParams,
         });
     }
+    /**
+     * This method refreshes the token of an invite. It sends a request to the
+     * [Refresh Invite Token](https://docs.medusajs.com/v2/api/admin#invites_postinvitesidresend)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The invite's details.
+     *
+     * @example
+     * sdk.admin.invite.resend("invite_123")
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     */
     async resend(id, headers) {
         return await this.client.fetch(`/admin/invites/${id}/resend`, {
             method: "POST",
             headers,
         });
     }
+    /**
+     * This method deletes an invite. It sends a request to the
+     * [Delete Invite](https://docs.medusajs.com/v2/api/admin#invites_deleteinvitesid)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.invite.delete("invite_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/invites/${id}`, {
             method: "DELETE",

package/dist/admin/invite.js.map

@@ -1 +1 @@
-{"version":3,"file":"invite.js","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":";;;AASA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,KAA6D,EAC7D,KAAoB,EACpB,OAAuB;QAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;QACvC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,KAAK,CAAC,YAAY,EAAE,EACnD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,WAAwB,EAAE,OAAuB;QAC1D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,gBAAgB,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAnFD,wBAmFC"}
+{"version":3,"file":"invite.js","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":";;;AAQA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,MAAM,CACV,KAKC,EACD,KAAoB,EACpB,OAAuB;QAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;QACvC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,KAAK,CAAC,YAAY,EAAE,EACnD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,WAAwB,EAAE,OAAuB;QAC1D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,gBAAgB,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AA1PD,wBA0PC"}

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

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