@medusajs/js-sdk 2.0.1-snapshot-20241025090810 → 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/admin/price-list.d.ts

@@ -10,12 +10,206 @@ export declare class PriceList {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a price list. It sends a request to the
+     * [Get Price List](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelistsid)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * To retrieve a price list by its ID:
+     *
+     * ```ts
+     * sdk.admin.priceList.retrieve("plist_123")
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.priceList.retrieve("plist_123", {
+     *   fields: "id,*prices"
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     * ```
+     *
+     * 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.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
+    /**
+     * This method retrieves a paginated list of price lists. It sends a request to the
+     * [List Price Lists](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelists) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of price lists.
+     *
+     * @example
+     * To retrieve the list of price lists:
+     *
+     * ```ts
+     * sdk.admin.priceList.list()
+     * .then(({ price_lists, count, limit, offset }) => {
+     *   console.log(price_lists)
+     * })
+     * ```
+     *
+     * 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.priceList.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ price_lists, count, limit, offset }) => {
+     *   console.log(price_lists)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each price list:
+     *
+     * ```ts
+     * sdk.admin.priceList.list({
+     *   fields: "id,*prices"
+     * })
+     * .then(({ price_lists, count, limit, offset }) => {
+     *   console.log(price_lists)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminPriceListListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListListResponse>;
+    /**
+     * This method creates a price list. It sends a request to the
+     * [Create Price List](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelists)
+     * API route.
+     *
+     * @param body - The details of the price list to create.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.create({
+     *   title: "My Price List",
+     *   status: "active",
+     *   type: "sale",
+     *   prices: [
+     *     {
+     *       variant_id: "variant_123",
+     *       amount: 10,
+     *       currency_code: "usd",
+     *       rules: {
+     *         region_id: "reg_123"
+     *       }
+     *     }
+     *   ]
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     */
     create(body: HttpTypes.AdminCreatePriceList, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
+    /**
+     * This method updates a price list. It sends a request to the
+     * [Update Price List](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsid)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param body - The data to update in the price list.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.update("plist_123", {
+     *   title: "My Price List",
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdatePriceList, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
+    /**
+     * This method deletes a price list. It sends a request to the
+     * [Delete Price List](https://docs.medusajs.com/v2/api/admin#price-lists_deletepricelistsid)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.priceList.delete("plist_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListDeleteResponse>;
-    batchPrices(id: string, body: HttpTypes.AdminBatchPriceListPrice, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
+    /**
+     * This method manages the prices of a price list to create, update, or delete them.
+     * It sends a request to the [Manage Prices](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsidpricesbatch)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param body - The prices to create, update, or delete.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.batchPrices("plist_123", {
+     *   create: [{
+     *     variant_id: "variant_123",
+     *     currency_code: "usd",
+     *     amount: 10,
+     *     rules: {
+     *       region_id: "reg_123"
+     *     }
+     *   }],
+     *   update: [{
+     *     id: "price_123",
+     *     variant_id: "variant_123",
+     *     amount: 20,
+     *   }],
+     *   delete: ["price_123"]
+     * })
+     * .then(({ created, updated, deleted }) => {
+     *   console.log(created, updated, deleted)
+     * })
+     */
+    batchPrices(id: string, body: HttpTypes.AdminBatchPriceListPrice, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListBatchResponse>;
+    /**
+     * This method removes products from a price list. It sends a request to the
+     * [Remove Product](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsidproducts)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param body - The details of the products to remove.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.linkProducts("plist_123", {
+     *   remove: ["prod_123"]
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     */
     linkProducts(id: string, body: HttpTypes.AdminLinkPriceListProducts, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
 }
 //# sourceMappingURL=price-list.d.ts.map

package/dist/admin/price-list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"price-list.d.ts","sourceRoot":"","sources":["../../src/admin/price-list.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,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAanB,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;CAY1B"}
+{"version":3,"file":"price-list.d.ts","sourceRoot":"","sources":["../../src/admin/price-list.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,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;CAY1B"}