@medusajs/js-sdk 2.0.1 → 2.0.2-snapshot-20241104135243

package/dist/admin/payment-collection.js

@@ -8,6 +8,24 @@ class PaymentCollection {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a payment collection. It sends a request to the
+     * [Create Payment Collection](https://docs.medusajs.com/api/admin#payment-collections_postpaymentcollections)
+     * API route.
+     *
+     * @param body - The details of the payment collection to create.
+     * @param query - Configure the fields to retrieve in the payment collection.
+     * @param headers - Headers to pass in the request
+     * @returns The payment collection's details.
+     *
+     * @example
+     * sdk.admin.paymentCollection.create({
+     *   order_id: "order_123"
+     * })
+     * .then(({ payment_collection }) => {
+     *   console.log(payment_collection)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/payment-collections`, {
             method: "POST",
@@ -16,12 +34,49 @@ class PaymentCollection {
             query,
         });
     }
+    /**
+     * This method deletes a payment collection. It sends a request to the
+     * [Delete Payment Collection](https://docs.medusajs.com/api/admin#payment-collections_deletepaymentcollectionsid)
+     * API route.
+     *
+     * @param id - The payment collection's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.paymentCollection.delete("paycol_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/payment-collections/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method marks a payment collection as paid. It sends a request to the
+     * [Mark as Paid](https://docs.medusajs.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid)
+     * API route.
+     *
+     * The API route creates and authorizes a payment session, then capture its payment,
+     * using the manual payment provider.
+     *
+     * @param id - The payment collection to mark as paid.
+     * @param body - The details to mark the payment collection as paid.
+     * @param query - Configure the fields to retrieve in the payment collection.
+     * @param headers - Headers to pass in the request.
+     * @returns The payment collection's details.
+     *
+     * @example
+     * sdk.admin.paymentCollection.markAsPaid("paycol_123", {
+     *   order_id: "order_123"
+     * })
+     * .then(({ payment_collection }) => {
+     *   console.log(payment_collection)
+     * })
+     */
     async markAsPaid(id, body, query, headers) {
         return await this.client.fetch(`/admin/payment-collections/${id}/mark-as-paid`, {
             method: "POST",

package/dist/admin/payment-collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-collection.js","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAA4C,EAC5C,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4BAA4B,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAAE,EAAE,EAClC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,EAAU,EACV,IAAgD,EAChD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAAE,eAAe,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAtDD,8CAsDC"}
+{"version":3,"file":"payment-collection.js","sourceRoot":"","sources":["../../src/admin/payment-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAA4C,EAC5C,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4BAA4B,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAAE,EAAE,EAClC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,IAAgD,EAChD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAAE,eAAe,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AA7GD,8CA6GC"}

package/dist/admin/payment.d.ts

@@ -10,10 +10,171 @@ export declare class Payment {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a paginated list of payments. It sends a request to the
+     * [List Payments](https://docs.medusajs.com/api/admin#payments_getpayments) API route.
+     *
+     * @param query  - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of payments.
+     *
+     * @example
+     * To retrieve the list of payments:
+     *
+     * ```ts
+     * sdk.admin.payment.list()
+     * .then(({ payments, count, limit, offset }) => {
+     *   console.log(payments)
+     * })
+     * ```
+     *
+     * 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.payment.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ payments, count, limit, offset }) => {
+     *   console.log(payments)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each payment:
+     *
+     * ```ts
+     * sdk.admin.payment.list({
+     *   fields: "id,*payment_collection"
+     * })
+     * .then(({ payments, count, limit, offset }) => {
+     *   console.log(payments)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminPaymentFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentsResponse>;
+    /**
+     * This method retrieves a paginated list of payment providers. It sends a request to the
+     * [List Payment Providers](https://docs.medusajs.com/api/admin#payments_getpaymentspaymentproviders) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of payment providers.
+     *
+     * @example
+     * To retrieve the list of payment providers:
+     *
+     * ```ts
+     * sdk.admin.payment.listPaymentProviders()
+     * .then(({ payment_providers, count, limit, offset }) => {
+     *   console.log(payment_providers)
+     * })
+     * ```
+     *
+     * 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.payment.listPaymentProviders({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ payment_providers, count, limit, offset }) => {
+     *   console.log(payment_providers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each payment provider:
+     *
+     * ```ts
+     * sdk.admin.payment.listPaymentProviders({
+     *   fields: "id,is_enabled"
+     * })
+     * .then(({ payment_providers, count, limit, offset }) => {
+     *   console.log(payment_providers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     listPaymentProviders(query?: HttpTypes.AdminGetPaymentProvidersParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentProviderListResponse>;
-    retrieve(id: string, query?: HttpTypes.AdminPaymentFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentResponse>;
+    /**
+     * This method retrieves a payment's details. It sends a request to the
+     * [Get Payment](https://docs.medusajs.com/api/admin#payments_getpaymentsid)
+     * API route.
+     *
+     * @param id - The payment's ID.
+     * @param query - Configure the fields to retrieve in the payment.
+     * @param headers - Headers to pass in the request
+     * @returns The payment's details.
+     *
+     * @example
+     * To retrieve a payment by its ID:
+     *
+     * ```ts
+     * sdk.admin.payment.retrieve("pay_123")
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.payment.retrieve("pay_123", {
+     *   fields: "id,*payment_collection"
+     * })
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
+    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentResponse>;
+    /**
+     * This method captures a payment. It sends a request to the
+     * [Capture Payment](https://docs.medusajs.com/api/admin#payments_postpaymentsidcapture) API route.
+     *
+     * The API route uses the `capturePayment` method of the payment provider associated with the payment's collection.
+     *
+     * @param id - The payment's ID.
+     * @param body - The capture's details.
+     * @param query - Configure the fields to retrieve in the payment.
+     * @param headers - Headers to pass in the request
+     * @returns The payment's details.
+     *
+     * @example
+     * sdk.admin.payment.capture("paycol_123", {})
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     */
     capture(id: string, body: HttpTypes.AdminCapturePayment, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentResponse>;
+    /**
+     * This method refunds a payment. It sends a request to the
+     * [Refund Payment](https://docs.medusajs.com/api/admin#payments_postpaymentsidrefund) API route.
+     *
+     * The API route uses the `refundPayment` method of the payment provider associated with the payment's collection.
+     *
+     * @param id - The payment's ID.
+     * @param body - The refund's details.
+     * @param query - Configure the fields to retrieve in the payment.
+     * @param headers - Headers to pass in the request
+     * @returns The payment's details.
+     *
+     * @example
+     * sdk.admin.payment.refund("paycol_123", {})
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     */
     refund(id: string, body: HttpTypes.AdminRefundPayment, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentResponse>;
 }
 //# sourceMappingURL=payment.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../src/admin/payment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,OAAO;IAClB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,aAAa;IAUnE,oBAAoB,CACxB,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EACrC,OAAO,CAAC,EAAE,aAAa;IAWnB,OAAO,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}
+{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../src/admin/payment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,OAAO;IAClB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,aAAa;IAUzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,oBAAoB,CACxB,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}

package/dist/admin/payment.js

@@ -8,24 +8,167 @@ class Payment {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a paginated list of payments. It sends a request to the
+     * [List Payments](https://docs.medusajs.com/api/admin#payments_getpayments) API route.
+     *
+     * @param query  - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of payments.
+     *
+     * @example
+     * To retrieve the list of payments:
+     *
+     * ```ts
+     * sdk.admin.payment.list()
+     * .then(({ payments, count, limit, offset }) => {
+     *   console.log(payments)
+     * })
+     * ```
+     *
+     * 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.payment.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ payments, count, limit, offset }) => {
+     *   console.log(payments)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each payment:
+     *
+     * ```ts
+     * sdk.admin.payment.list({
+     *   fields: "id,*payment_collection"
+     * })
+     * .then(({ payments, count, limit, offset }) => {
+     *   console.log(payments)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async list(query, headers) {
         return await this.client.fetch(`/admin/payments`, {
             query,
             headers,
         });
     }
+    /**
+     * This method retrieves a paginated list of payment providers. It sends a request to the
+     * [List Payment Providers](https://docs.medusajs.com/api/admin#payments_getpaymentspaymentproviders) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of payment providers.
+     *
+     * @example
+     * To retrieve the list of payment providers:
+     *
+     * ```ts
+     * sdk.admin.payment.listPaymentProviders()
+     * .then(({ payment_providers, count, limit, offset }) => {
+     *   console.log(payment_providers)
+     * })
+     * ```
+     *
+     * 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.payment.listPaymentProviders({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ payment_providers, count, limit, offset }) => {
+     *   console.log(payment_providers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each payment provider:
+     *
+     * ```ts
+     * sdk.admin.payment.listPaymentProviders({
+     *   fields: "id,is_enabled"
+     * })
+     * .then(({ payment_providers, count, limit, offset }) => {
+     *   console.log(payment_providers)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async listPaymentProviders(query, headers) {
         return await this.client.fetch(`/admin/payments/payment-providers`, {
             query,
             headers,
         });
     }
+    /**
+     * This method retrieves a payment's details. It sends a request to the
+     * [Get Payment](https://docs.medusajs.com/api/admin#payments_getpaymentsid)
+     * API route.
+     *
+     * @param id - The payment's ID.
+     * @param query - Configure the fields to retrieve in the payment.
+     * @param headers - Headers to pass in the request
+     * @returns The payment's details.
+     *
+     * @example
+     * To retrieve a payment by its ID:
+     *
+     * ```ts
+     * sdk.admin.payment.retrieve("pay_123")
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.payment.retrieve("pay_123", {
+     *   fields: "id,*payment_collection"
+     * })
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/payments/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method captures a payment. It sends a request to the
+     * [Capture Payment](https://docs.medusajs.com/api/admin#payments_postpaymentsidcapture) API route.
+     *
+     * The API route uses the `capturePayment` method of the payment provider associated with the payment's collection.
+     *
+     * @param id - The payment's ID.
+     * @param body - The capture's details.
+     * @param query - Configure the fields to retrieve in the payment.
+     * @param headers - Headers to pass in the request
+     * @returns The payment's details.
+     *
+     * @example
+     * sdk.admin.payment.capture("paycol_123", {})
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     */
     async capture(id, body, query, headers) {
         return await this.client.fetch(`/admin/payments/${id}/capture`, {
             method: "POST",
@@ -34,6 +177,24 @@ class Payment {
             query,
         });
     }
+    /**
+     * This method refunds a payment. It sends a request to the
+     * [Refund Payment](https://docs.medusajs.com/api/admin#payments_postpaymentsidrefund) API route.
+     *
+     * The API route uses the `refundPayment` method of the payment provider associated with the payment's collection.
+     *
+     * @param id - The payment's ID.
+     * @param body - The refund's details.
+     * @param query - Configure the fields to retrieve in the payment.
+     * @param headers - Headers to pass in the request
+     * @returns The payment's details.
+     *
+     * @example
+     * sdk.admin.payment.refund("paycol_123", {})
+     * .then(({ payment }) => {
+     *   console.log(payment)
+     * })
+     */
     async refund(id, body, query, headers) {
         return await this.client.fetch(`/admin/payments/${id}/refund`, {
             method: "POST",

package/dist/admin/payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/admin/payment.ts"],"names":[],"mappings":";;;AAIA,MAAa,OAAO;IAKlB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAqC,EAAE,OAAuB;QACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,KAAgD,EAChD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mCAAmC,EACnC;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAqC,EACrC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,UAAU,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAkC,EAClC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,SAAS,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlFD,0BAkFC"}
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/admin/payment.ts"],"names":[],"mappings":";;;AAIA,MAAa,OAAO;IAKlB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CAAC,KAAqC,EAAE,OAAuB;QACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,oBAAoB,CACxB,KAAgD,EAChD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mCAAmC,EACnC;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,UAAU,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAkC,EAClC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,SAAS,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAnPD,0BAmPC"}

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

@@ -10,7 +10,87 @@ export declare class Notification {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a notification's details. It sends a request to the
+     * [Get Notification](https://docs.medusajs.com/api/admin#notifications_getnotificationsid)
+     * API route.
+     *
+     * @param id - The notification's ID.
+     * @param query - Configure the fields to retrieve in the notification.
+     * @param headers - Headers to pass in the request
+     * @returns The notification's details.
+     *
+     * @example
+     * To retrieve a notification by its ID:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123")
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123", {
+     *   fields: "id,to"
+     * })
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminNotificationParams, headers?: ClientHeaders): Promise<HttpTypes.AdminNotificationResponse>;
+    /**
+     * This method retrieves a paginated list of notifications. It sends a request to the
+     * [List Notifications](https://docs.medusajs.com/api/admin#notifications_getnotifications)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of notifications.
+     *
+     * @example
+     * To retrieve the list of notifications:
+     *
+     * ```ts
+     * sdk.admin.notification.list()
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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.notification.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each notification:
+     *
+     * ```ts
+     * sdk.admin.notification.list({
+     *   fields: "id,to"
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminNotificationListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminNotificationListResponse>;
 }
 //# sourceMappingURL=notification.d.ts.map

package/dist/esm/admin/notification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../src/admin/notification.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,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../src/admin/notification.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,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/esm/admin/notification.js

@@ -14,6 +14,39 @@ export class Notification {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a notification's details. It sends a request to the
+     * [Get Notification](https://docs.medusajs.com/api/admin#notifications_getnotificationsid)
+     * API route.
+     *
+     * @param id - The notification's ID.
+     * @param query - Configure the fields to retrieve in the notification.
+     * @param headers - Headers to pass in the request
+     * @returns The notification's details.
+     *
+     * @example
+     * To retrieve a notification by its ID:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123")
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123", {
+     *   fields: "id,to"
+     * })
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/notifications/${id}`, {
@@ -23,6 +56,53 @@ export class Notification {
             });
         });
     }
+    /**
+     * This method retrieves a paginated list of notifications. It sends a request to the
+     * [List Notifications](https://docs.medusajs.com/api/admin#notifications_getnotifications)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of notifications.
+     *
+     * @example
+     * To retrieve the list of notifications:
+     *
+     * ```ts
+     * sdk.admin.notification.list()
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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.notification.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each notification:
+     *
+     * ```ts
+     * sdk.admin.notification.list({
+     *   fields: "id,to"
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/notifications`, {

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

@@ -1 +1 @@
-{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/admin/notification.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/admin/notification.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}