From a1190b72087e78b8b819b0a0885e111850563d8b Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 22 Oct 2024 20:31:32 +0300 Subject: [PATCH] docs: generate + configure js sdk reference (#9714) Manually generate the JS SDK reference + add it to the sidebar --- .../components/Tags/Operation/index.tsx | 121 +- .../components/Tags/Paths/index.tsx | 42 +- .../components/Tags/Section/Schema/index.tsx | 74 +- .../components/Tags/Section/index.tsx | 53 +- .../api-reference/components/Tags/index.tsx | 5 +- .../api-reference/providers/base-specs.tsx | 49 +- www/apps/resources/generated/edit-dates.mjs | 461 +- www/apps/resources/generated/files-map.mjs | 1812 + www/apps/resources/generated/sidebar.mjs | 491 +- www/apps/resources/generated/slug-changes.mjs | 300 + .../js_sdk.admin.Admin.apiKey/page.mdx | 215 + .../js_sdk.admin.Admin.campaign/page.mdx | 193 + .../js_sdk.admin.Admin.claim/page.mdx | 696 + .../js_sdk.admin.Admin.currency/page.mdx | 102 + .../js_sdk.admin.Admin.customer/page.mdx | 180 + .../js_sdk.admin.Admin.customerGroup/page.mdx | 209 + .../js_sdk.admin.Admin.exchange/page.mdx | 605 + .../js_sdk.admin.Admin.fulfillment/page.mdx | 44 + .../page.mdx | 63 + .../page.mdx | 68 + .../js_sdk.admin.Admin.inventoryItem/page.mdx | 116 + .../js_sdk.admin.Admin.invite/page.mdx | 80 + .../js_sdk.admin.Admin.notification/page.mdx | 32 + .../js_sdk.admin.Admin.order/page.mdx | 128 + .../js_sdk.admin.Admin.orderEdit/page.mdx | 104 + .../js_sdk.admin.Admin.payment/page.mdx | 68 + .../page.mdx | 68 + .../js_sdk.admin.Admin.priceList/page.mdx | 92 + .../page.mdx | 68 + .../js_sdk.admin.Admin.product/page.mdx | 260 + .../page.mdx | 80 + .../page.mdx | 80 + .../js_sdk.admin.Admin.productTag/page.mdx | 68 + .../js_sdk.admin.Admin.productType/page.mdx | 68 + .../page.mdx | 20 + .../js_sdk.admin.Admin.promotion/page.mdx | 140 + .../js_sdk.admin.Admin.refundReason/page.mdx | 20 + .../js_sdk.admin.Admin.region/page.mdx | 68 + .../js_sdk.admin.Admin.reservation/page.mdx | 68 + .../js_sdk.admin.Admin.return/page.mdx | 272 + .../js_sdk.admin.Admin.returnReason/page.mdx | 68 + .../js_sdk.admin.Admin.salesChannel/page.mdx | 92 + .../page.mdx | 80 + .../page.mdx | 68 + .../js_sdk.admin.Admin.stockLocation/page.mdx | 104 + .../js_sdk.admin.Admin.store/page.mdx | 44 + .../js_sdk.admin.Admin.taxRate/page.mdx | 68 + .../js_sdk.admin.Admin.taxRegion/page.mdx | 56 + .../js_sdk.admin.Admin.upload/page.mdx | 44 + .../js_sdk.admin.Admin.user/page.mdx | 80 + .../page.mdx | 32 + .../page.mdx | 27 + .../js_sdk.admin.ApiKey.create/page.mdx | 26 + .../js_sdk.admin.ApiKey.delete/page.mdx | 23 + .../methods/js_sdk.admin.ApiKey.list/page.mdx | 53 + .../js_sdk.admin.ApiKey.retrieve/page.mdx | 23 + .../js_sdk.admin.ApiKey.revoke/page.mdx | 23 + .../js_sdk.admin.ApiKey.update/page.mdx | 25 + .../js_sdk.admin.ApiKey.client/page.mdx | 223 + .../page.mdx | 15 + .../js_sdk.admin.Campaign.create/page.mdx | 25 + .../js_sdk.admin.Campaign.delete/page.mdx | 23 + .../js_sdk.admin.Campaign.list/page.mdx | 53 + .../js_sdk.admin.Campaign.retrieve/page.mdx | 38 + .../js_sdk.admin.Campaign.update/page.mdx | 25 + .../js_sdk.admin.Campaign.client/page.mdx | 223 + .../page.mdx | 35 + .../page.mdx | 32 + .../js_sdk.admin.Claim.addItems/page.mdx | 30 + .../page.mdx | 32 + .../page.mdx | 33 + .../js_sdk.admin.Claim.cancel/page.mdx | 23 + .../js_sdk.admin.Claim.cancelRequest/page.mdx | 26 + .../js_sdk.admin.Claim.create/page.mdx | 26 + .../page.mdx | 30 + .../page.mdx | 28 + .../methods/js_sdk.admin.Claim.list/page.mdx | 53 + .../page.mdx | 30 + .../js_sdk.admin.Claim.removeItem/page.mdx | 30 + .../page.mdx | 30 + .../js_sdk.admin.Claim.request/page.mdx | 27 + .../js_sdk.admin.Claim.retrieve/page.mdx | 38 + .../page.mdx | 33 + .../page.mdx | 33 + .../js_sdk.admin.Claim.updateItem/page.mdx | 32 + .../page.mdx | 33 + .../page.mdx | 33 + .../js_sdk.admin.Claim.client/page.mdx | 223 + .../js_sdk.admin.Client.clearToken/page.mdx | 7 + .../js_sdk.admin.Client.clearToken_/page.mdx | 7 + .../js_sdk.admin.Client.fetch/page.mdx | 22 + .../js_sdk.admin.Client.fetchStream/page.mdx | 16 + .../page.mdx | 7 + .../page.mdx | 7 + .../page.mdx | 7 + .../page.mdx | 9 + .../js_sdk.admin.Client.getToken_/page.mdx | 7 + .../js_sdk.admin.Client.initClient/page.mdx | 7 + .../js_sdk.admin.Client.setToken/page.mdx | 11 + .../js_sdk.admin.Client.setToken_/page.mdx | 11 + .../page.mdx | 3 + .../js_sdk.admin.Client.config/page.mdx | 87 + .../js_sdk.admin.Client.fetch_/page.mdx | 3 + .../js_sdk.admin.Client.logger/page.mdx | 49 + .../js_sdk.admin.Client.token/page.mdx | 3 + .../js_sdk.admin.Currency.list/page.mdx | 54 + .../js_sdk.admin.Currency.retrieve/page.mdx | 38 + .../js_sdk.admin.Currency.client/page.mdx | 223 + .../js_sdk.admin.Customer.create/page.mdx | 25 + .../js_sdk.admin.Customer.delete/page.mdx | 24 + .../js_sdk.admin.Customer.list/page.mdx | 54 + .../js_sdk.admin.Customer.retrieve/page.mdx | 39 + .../js_sdk.admin.Customer.update/page.mdx | 25 + .../js_sdk.admin.Customer.client/page.mdx | 223 + .../page.mdx | 27 + .../page.mdx | 26 + .../page.mdx | 24 + .../js_sdk.admin.CustomerGroup.list/page.mdx | 54 + .../page.mdx | 38 + .../page.mdx | 26 + .../page.mdx | 223 + .../page.mdx | 31 + .../page.mdx | 31 + .../page.mdx | 31 + .../page.mdx | 28 + .../js_sdk.admin.Exchange.cancel/page.mdx | 23 + .../page.mdx | 24 + .../js_sdk.admin.Exchange.create/page.mdx | 25 + .../page.mdx | 32 + .../page.mdx | 32 + .../js_sdk.admin.Exchange.list/page.mdx | 54 + .../page.mdx | 32 + .../page.mdx | 32 + .../js_sdk.admin.Exchange.request/page.mdx | 25 + .../js_sdk.admin.Exchange.retrieve/page.mdx | 39 + .../page.mdx | 35 + .../page.mdx | 35 + .../page.mdx | 35 + .../page.mdx | 35 + .../js_sdk.admin.Exchange.client/page.mdx | 223 + .../page.mdx | 7 + .../page.mdx | 13 + .../js_sdk.admin.Fulfillment.cancel/page.mdx | 11 + .../js_sdk.admin.Fulfillment.create/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Fulfillment.client/page.mdx | 223 + .../page.mdx | 54 + .../page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.InventoryItem.list/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../js_sdk.admin.Invite.accept/page.mdx | 11 + .../js_sdk.admin.Invite.create/page.mdx | 11 + .../js_sdk.admin.Invite.delete/page.mdx | 11 + .../methods/js_sdk.admin.Invite.list/page.mdx | 11 + .../js_sdk.admin.Invite.resend/page.mdx | 11 + .../js_sdk.admin.Invite.retrieve/page.mdx | 11 + .../js_sdk.admin.Invite.client/page.mdx | 223 + .../js_sdk.admin.Notification.list/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Notification.client/page.mdx | 223 + .../js_sdk.admin.Order.cancel/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../methods/js_sdk.admin.Order.list/page.mdx | 11 + .../js_sdk.admin.Order.listChanges/page.mdx | 11 + .../js_sdk.admin.Order.listLineItems/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Order.retrieve/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Order.client/page.mdx | 223 + .../js_sdk.admin.OrderEdit.addItems/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.OrderEdit.confirm/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.OrderEdit.request/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.OrderEdit.client/page.mdx | 223 + .../js_sdk.admin.Payment.capture/page.mdx | 11 + .../js_sdk.admin.Payment.list/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Payment.refund/page.mdx | 11 + .../js_sdk.admin.Payment.retrieve/page.mdx | 11 + .../js_sdk.admin.Payment.client/page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../page.mdx | 11 + .../js_sdk.admin.PriceList.create/page.mdx | 11 + .../js_sdk.admin.PriceList.delete/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.PriceList.list/page.mdx | 11 + .../js_sdk.admin.PriceList.retrieve/page.mdx | 11 + .../js_sdk.admin.PriceList.update/page.mdx | 11 + .../js_sdk.admin.PriceList.client/page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../js_sdk.admin.Product.batch/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Product.create/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Product.delete/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Product.export/page.mdx | 11 + .../js_sdk.admin.Product.import/page.mdx | 11 + .../js_sdk.admin.Product.list/page.mdx | 11 + .../js_sdk.admin.Product.listOptions/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Product.retrieve/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Product.update/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Product.client/page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../js_sdk.admin.ProductTag.create/page.mdx | 11 + .../js_sdk.admin.ProductTag.delete/page.mdx | 11 + .../js_sdk.admin.ProductTag.list/page.mdx | 11 + .../js_sdk.admin.ProductTag.retrieve/page.mdx | 11 + .../js_sdk.admin.ProductTag.update/page.mdx | 11 + .../js_sdk.admin.ProductTag.client/page.mdx | 223 + .../js_sdk.admin.ProductType.create/page.mdx | 11 + .../js_sdk.admin.ProductType.delete/page.mdx | 11 + .../js_sdk.admin.ProductType.list/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.ProductType.update/page.mdx | 11 + .../js_sdk.admin.ProductType.client/page.mdx | 223 + .../js_sdk.admin.ProductVariant.list/page.mdx | 11 + .../page.mdx | 223 + .../js_sdk.admin.Promotion.addRules/page.mdx | 11 + .../js_sdk.admin.Promotion.create/page.mdx | 11 + .../js_sdk.admin.Promotion.delete/page.mdx | 11 + .../js_sdk.admin.Promotion.list/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Promotion.listRules/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Promotion.retrieve/page.mdx | 11 + .../js_sdk.admin.Promotion.update/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Promotion.client/page.mdx | 223 + .../js_sdk.admin.RefundReason.list/page.mdx | 11 + .../js_sdk.admin.RefundReason.client/page.mdx | 223 + .../js_sdk.admin.Region.create/page.mdx | 11 + .../js_sdk.admin.Region.delete/page.mdx | 11 + .../methods/js_sdk.admin.Region.list/page.mdx | 11 + .../js_sdk.admin.Region.retrieve/page.mdx | 11 + .../js_sdk.admin.Region.update/page.mdx | 11 + .../js_sdk.admin.Region.client/page.mdx | 223 + .../js_sdk.admin.Reservation.create/page.mdx | 11 + .../js_sdk.admin.Reservation.delete/page.mdx | 11 + .../js_sdk.admin.Reservation.list/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Reservation.update/page.mdx | 11 + .../js_sdk.admin.Reservation.client/page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Return.cancel/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Return.dismissItems/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../methods/js_sdk.admin.Return.list/page.mdx | 11 + .../js_sdk.admin.Return.receiveItems/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Return.retrieve/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.Return.client/page.mdx | 223 + .../js_sdk.admin.ReturnReason.create/page.mdx | 11 + .../js_sdk.admin.ReturnReason.delete/page.mdx | 11 + .../js_sdk.admin.ReturnReason.list/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.ReturnReason.update/page.mdx | 11 + .../js_sdk.admin.ReturnReason.client/page.mdx | 223 + .../page.mdx | 11 + .../js_sdk.admin.SalesChannel.create/page.mdx | 11 + .../js_sdk.admin.SalesChannel.delete/page.mdx | 11 + .../js_sdk.admin.SalesChannel.list/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.SalesChannel.update/page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.SalesChannel.client/page.mdx | 223 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.ShippingOption.list/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../js_sdk.admin.StockLocation.list/page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../methods/js_sdk.admin.Store.list/page.mdx | 11 + .../js_sdk.admin.Store.retrieve/page.mdx | 11 + .../js_sdk.admin.Store.update/page.mdx | 11 + .../js_sdk.admin.Store.client/page.mdx | 223 + .../js_sdk.admin.TaxRate.create/page.mdx | 11 + .../js_sdk.admin.TaxRate.delete/page.mdx | 11 + .../js_sdk.admin.TaxRate.list/page.mdx | 11 + .../js_sdk.admin.TaxRate.retrieve/page.mdx | 11 + .../js_sdk.admin.TaxRate.update/page.mdx | 11 + .../js_sdk.admin.TaxRate.client/page.mdx | 223 + .../js_sdk.admin.TaxRegion.create/page.mdx | 11 + .../js_sdk.admin.TaxRegion.delete/page.mdx | 11 + .../js_sdk.admin.TaxRegion.list/page.mdx | 11 + .../js_sdk.admin.TaxRegion.retrieve/page.mdx | 11 + .../js_sdk.admin.TaxRegion.client/page.mdx | 223 + .../js_sdk.admin.Upload.create/page.mdx | 11 + .../js_sdk.admin.Upload.delete/page.mdx | 11 + .../js_sdk.admin.Upload.retrieve/page.mdx | 11 + .../js_sdk.admin.Upload.client/page.mdx | 223 + .../methods/js_sdk.admin.User.create/page.mdx | 11 + .../methods/js_sdk.admin.User.delete/page.mdx | 11 + .../methods/js_sdk.admin.User.list/page.mdx | 11 + .../methods/js_sdk.admin.User.me/page.mdx | 11 + .../js_sdk.admin.User.retrieve/page.mdx | 11 + .../methods/js_sdk.admin.User.update/page.mdx | 11 + .../js_sdk.admin.User.client/page.mdx | 223 + .../page.mdx | 11 + .../page.mdx | 11 + .../page.mdx | 223 + .../admin/classes/js_sdk.admin.Admin/page.mdx | 53 + .../classes/js_sdk.admin.ApiKey/page.mdx | 17 + .../classes/js_sdk.admin.Campaign/page.mdx | 16 + .../admin/classes/js_sdk.admin.Claim/page.mdx | 31 + .../classes/js_sdk.admin.Client/page.mdx | 26 + .../classes/js_sdk.admin.Currency/page.mdx | 12 + .../classes/js_sdk.admin.Customer/page.mdx | 15 + .../js_sdk.admin.CustomerGroup/page.mdx | 16 + .../classes/js_sdk.admin.Exchange/page.mdx | 28 + .../classes/js_sdk.admin.Fulfillment/page.mdx | 13 + .../js_sdk.admin.FulfillmentProvider/page.mdx | 11 + .../js_sdk.admin.FulfillmentSet/page.mdx | 15 + .../js_sdk.admin.InventoryItem/page.mdx | 19 + .../classes/js_sdk.admin.Invite/page.mdx | 16 + .../js_sdk.admin.Notification/page.mdx | 12 + .../admin/classes/js_sdk.admin.Order/page.mdx | 20 + .../classes/js_sdk.admin.OrderEdit/page.mdx | 18 + .../classes/js_sdk.admin.Payment/page.mdx | 15 + .../js_sdk.admin.PaymentCollection/page.mdx | 15 + .../classes/js_sdk.admin.PriceList/page.mdx | 17 + .../js_sdk.admin.PricePreference/page.mdx | 15 + .../classes/js_sdk.admin.Product/page.mdx | 31 + .../js_sdk.admin.ProductCategory/page.mdx | 16 + .../js_sdk.admin.ProductCollection/page.mdx | 16 + .../classes/js_sdk.admin.ProductTag/page.mdx | 15 + .../classes/js_sdk.admin.ProductType/page.mdx | 15 + .../js_sdk.admin.ProductVariant/page.mdx | 11 + .../classes/js_sdk.admin.Promotion/page.mdx | 21 + .../js_sdk.admin.RefundReason/page.mdx | 11 + .../classes/js_sdk.admin.Region/page.mdx | 15 + .../classes/js_sdk.admin.Reservation/page.mdx | 15 + .../classes/js_sdk.admin.Return/page.mdx | 32 + .../js_sdk.admin.ReturnReason/page.mdx | 15 + .../js_sdk.admin.SalesChannel/page.mdx | 17 + .../js_sdk.admin.ShippingOption/page.mdx | 16 + .../js_sdk.admin.ShippingProfile/page.mdx | 15 + .../js_sdk.admin.StockLocation/page.mdx | 18 + .../admin/classes/js_sdk.admin.Store/page.mdx | 13 + .../classes/js_sdk.admin.TaxRate/page.mdx | 15 + .../classes/js_sdk.admin.TaxRegion/page.mdx | 14 + .../classes/js_sdk.admin.Upload/page.mdx | 13 + .../admin/classes/js_sdk.admin.User/page.mdx | 16 + .../js_sdk.admin.WorkflowExecution/page.mdx | 12 + .../js_sdk.admin.FetchStreamResponse/page.mdx | 8 + .../page.mdx | 11 + .../types/js_sdk.admin.ClientFetch/page.mdx | 11 + .../types/js_sdk.admin.ClientHeaders/page.mdx | 9 + .../admin/types/js_sdk.admin.Config/page.mdx | 171 + .../types/js_sdk.admin.FetchArgs/page.mdx | 19 + .../types/js_sdk.admin.FetchInput/page.mdx | 3 + .../types/js_sdk.admin.FetchParams/page.mdx | 3 + .../admin/types/js_sdk.admin.Logger/page.mdx | 95 + .../js_sdk.auth.Auth.callback/page.mdx | 35 + .../methods/js_sdk.auth.Auth.login/page.mdx | 42 + .../methods/js_sdk.auth.Auth.logout/page.mdx | 26 + .../methods/js_sdk.auth.Auth.refresh/page.mdx | 26 + .../js_sdk.auth.Auth.register/page.mdx | 34 + .../js_sdk.auth.Auth.resetPassword/page.mdx | 40 + .../js_sdk.auth.Auth.updateProvider/page.mdx | 43 + .../auth/classes/js_sdk.auth.Auth/page.mdx | 19 + .../js_sdk/modules/js_sdk.admin/page.mdx | 64 + .../js_sdk/modules/js_sdk.auth/page.mdx | 7 + .../js_sdk/modules/js_sdk.store/page.mdx | 7 + .../js_sdk.store.Store.cart/page.mdx | 510 + .../js_sdk.store.Store.category/page.mdx | 200 + .../js_sdk.store.Store.collection/page.mdx | 200 + .../js_sdk.store.Store.customer/page.mdx | 610 + .../js_sdk.store.Store.fulfillment/page.mdx | 64 + .../js_sdk.store.Store.order/page.mdx | 194 + .../js_sdk.store.Store.payment/page.mdx | 210 + .../js_sdk.store.Store.product/page.mdx | 212 + .../js_sdk.store.Store.region/page.mdx | 206 + .../store/classes/js_sdk.store.Store/page.mdx | 21 + .../references/modules/js_sdk/page.mdx | 9 + .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- www/apps/resources/sidebar.mjs | 22 + .../Sidebar/Item/Category/index.tsx | 2 + .../docs-ui/src/components/Sidebar/index.tsx | 24 +- .../generated/typedoc-json-output/js-sdk.json | 50396 ++++++++++++++++ .../src/constants/base-section-options.ts | 1 + .../constants/merger-custom-options/js-sdk.ts | 6 + .../src/render-utils.ts | 2 + .../resources/helpers/if-member-show-title.ts | 16 + .../src/resources/partials/member.hbs | 12 +- www/utils/packages/types/lib/index.d.ts | 1 + 476 files changed, 76450 insertions(+), 189 deletions(-) create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.apiKey/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.exchange/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.priceList/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.return/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.store/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.upload/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.user/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ApiKey/properties/js_sdk.admin.ApiKey.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.batchPromotions/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Campaign/properties/js_sdk.admin.Campaign.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.request/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Claim/properties/js_sdk.admin.Claim.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetch/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetchStream/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getApiKeyHeader_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getJwtHeader_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getTokenStorageInfo_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.initClient/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.DEFAULT_JWT_STORAGE_KEY/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.config/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.fetch_/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.logger/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.token/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Currency/properties/js_sdk.admin.Currency.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Customer/properties/js_sdk.admin.Customer.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/CustomerGroup/properties/js_sdk.admin.CustomerGroup.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancelRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.request/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Exchange/properties/js_sdk.admin.Exchange.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.abort/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.stream/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Fulfillment/properties/js_sdk.admin.Fulfillment.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentProvider/properties/js_sdk.admin.FulfillmentProvider.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.retrieveServiceZone/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.updateServiceZone/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/FulfillmentSet/properties/js_sdk.admin.FulfillmentSet.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/InventoryItem/properties/js_sdk.admin.InventoryItem.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.resend/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Invite/properties/js_sdk.admin.Invite.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Notification/properties/js_sdk.admin.Notification.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.initiateRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.removeAddedItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.request/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateAddedItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/OrderEdit/properties/js_sdk.admin.OrderEdit.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Payment/properties/js_sdk.admin.Payment.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PaymentCollection/properties/js_sdk.admin.PaymentCollection.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PriceList/properties/js_sdk.admin.PriceList.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/PricePreference/properties/js_sdk.admin.PricePreference.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Product/properties/js_sdk.admin.Product.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCategory/properties/js_sdk.admin.ProductCategory.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductCollection/properties/js_sdk.admin.ProductCollection.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductTag/properties/js_sdk.admin.ProductTag.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductType/properties/js_sdk.admin.ProductType.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ProductVariant/properties/js_sdk.admin.ProductVariant.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Promotion/properties/js_sdk.admin.Promotion.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/RefundReason/properties/js_sdk.admin.RefundReason.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Region/properties/js_sdk.admin.Region.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Reservation/properties/js_sdk.admin.Reservation.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelReceive/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmReceive/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.dismissItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateReceive/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReceiveItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateDismissItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReceiveItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateRequest/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnShipping/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Return/properties/js_sdk.admin.Return.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ReturnReason/properties/js_sdk.admin.ReturnReason.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/SalesChannel/properties/js_sdk.admin.SalesChannel.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.comment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.data/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.event/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.id/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.retry/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingOption/properties/js_sdk.admin.ShippingOption.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/ShippingProfile/properties/js_sdk.admin.ShippingProfile.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/StockLocation/properties/js_sdk.admin.StockLocation.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Store/properties/js_sdk.admin.Store.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRate/properties/js_sdk.admin.TaxRate.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/TaxRegion/properties/js_sdk.admin.TaxRegion.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/Upload/properties/js_sdk.admin.Upload.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.create/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.me/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.update/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/User/properties/js_sdk.admin.User.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/WorkflowExecution/properties/js_sdk.admin.WorkflowExecution.client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Admin/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ApiKey/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Campaign/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Claim/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Client/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Currency/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Customer/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.CustomerGroup/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Exchange/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Fulfillment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentProvider/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.InventoryItem/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PriceList/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PricePreference/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Product/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCategory/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCollection/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductTag/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductType/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductVariant/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Promotion/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.RefundReason/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Region/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Reservation/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Return/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ReturnReason/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.SalesChannel/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingOption/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingProfile/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.StockLocation/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Store/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRate/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRegion/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Upload/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.User/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.WorkflowExecution/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.FetchStreamResponse/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientFetch/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientHeaders/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Config/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchArgs/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchInput/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchParams/page.mdx create mode 100644 www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Logger/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.callback/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.login/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.logout/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.refresh/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.register/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.resetPassword/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.updateProvider/page.mdx create mode 100644 www/apps/resources/references/js_sdk/auth/classes/js_sdk.auth.Auth/page.mdx create mode 100644 www/apps/resources/references/js_sdk/modules/js_sdk.admin/page.mdx create mode 100644 www/apps/resources/references/js_sdk/modules/js_sdk.auth/page.mdx create mode 100644 www/apps/resources/references/js_sdk/modules/js_sdk.store/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx create mode 100644 www/apps/resources/references/js_sdk/store/classes/js_sdk.store.Store/page.mdx create mode 100644 www/apps/resources/references/modules/js_sdk/page.mdx create mode 100644 www/utils/generated/typedoc-json-output/js-sdk.json create mode 100644 www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-member-show-title.ts diff --git a/www/apps/api-reference/components/Tags/Operation/index.tsx b/www/apps/api-reference/components/Tags/Operation/index.tsx index df44a3c331..1dd618621d 100644 --- a/www/apps/api-reference/components/Tags/Operation/index.tsx +++ b/www/apps/api-reference/components/Tags/Operation/index.tsx @@ -6,7 +6,7 @@ import type { OpenAPIV3 } from "openapi-types" import getSectionId from "@/utils/get-section-id" import { useCallback, useEffect, useMemo, useRef, useState } from "react" import dynamic from "next/dynamic" -import { useInView } from "react-intersection-observer" +import { InView } from "react-intersection-observer" import { isElmWindow, useIsBrowser, @@ -20,6 +20,7 @@ import { useLoading } from "@/providers/loading" import { useRouter } from "next/navigation" import SectionDivider from "../../Section/Divider" import checkElementInViewport from "../../../utils/check-element-in-viewport" +import DividedLoading from "../../DividedLoading" const TagOperationCodeSection = dynamic( async () => import("./CodeSection") @@ -46,7 +47,7 @@ const TagOperation = ({ () => getSectionId([...(operation.tags || []), operation.operationId]), [operation] ) - const nodeRef = useRef(null) + const nodeRef = useRef(null) const { loading, removeLoading } = useLoading() const { scrollableElement, scrollToTop } = useScrollController() const { isBrowser } = useIsBrowser() @@ -57,40 +58,6 @@ const TagOperation = ({ return isElmWindow(scrollableElement) ? document.body : scrollableElement }, [isBrowser, scrollableElement]) - const { ref } = useInView({ - threshold: 0.3, - rootMargin: `112px 0px 112px 0px`, - root, - onChange: (changedInView) => { - if (changedInView) { - if (!show) { - if (loading) { - removeLoading() - } - setShow(true) - } - if (location.hash !== path) { - router.push(`#${path}`, { - scroll: false, - }) - } - if (activePath !== path) { - setActivePath(path) - } - } - }, - }) - - // Use `useCallback` so we don't recreate the function on each render - const setRefs = useCallback( - (node: Element | null) => { - // Ref's from useRef needs to have the node assigned to `current` - nodeRef.current = node - // Callback refs, like the one from `useInView`, is a function that takes the node as an argument - ref(node) - }, - [ref] - ) const scrollIntoView = useCallback(() => { if (!isBrowser) { @@ -105,14 +72,14 @@ const TagOperation = ({ ) } setShow(true) - }, [scrollToTop, nodeRef, isBrowser]) + }, [nodeRef, isBrowser, scrollToTop]) useEffect(() => { if (nodeRef && nodeRef.current) { removeLoading() const currentHash = location.hash.replace("#", "") if (currentHash === path) { - setTimeout(scrollIntoView, 100) + setTimeout(scrollIntoView, 200) } else if (currentHash.split("_")[0] === path.split("_")[0]) { setShow(true) } @@ -120,36 +87,66 @@ const TagOperation = ({ }, [nodeRef, path, scrollIntoView]) return ( -
{ + if (changedInView) { + if (!show) { + if (loading) { + removeLoading() + } + setShow(true) + } + if (location.hash !== path) { + router.push(`#${path}`, { + scroll: false, + }) + } + if (activePath !== path) { + setActivePath(path) + } + } else if ( + nodeRef.current && + !checkElementInViewport(nodeRef.current, 0) + ) { + setShow(false) + } + }} >
- - } - codeContent={ - } + {show && ( +
+ + } + codeContent={ + + } /> - } - /> +
+ )} +
- -
+ ) } diff --git a/www/apps/api-reference/components/Tags/Paths/index.tsx b/www/apps/api-reference/components/Tags/Paths/index.tsx index 431d2e92e3..aa6e3cf5c7 100644 --- a/www/apps/api-reference/components/Tags/Paths/index.tsx +++ b/www/apps/api-reference/components/Tags/Paths/index.tsx @@ -3,7 +3,7 @@ import type { OpenAPIV3 } from "openapi-types" import type { Operation, PathsObject } from "@/types/openapi" import { useSidebar } from "docs-ui" -import { Fragment, useEffect } from "react" +import { Fragment, Suspense, useEffect } from "react" import dynamic from "next/dynamic" import type { TagOperationProps } from "../Operation" import clsx from "clsx" @@ -48,25 +48,27 @@ const TagPaths = ({ tag, className, paths }: TagPathsProps) => { }, [paths]) return ( -
- {loading && } - {Object.entries(paths).map(([endpointPath, operations], pathIndex) => ( - - {Object.entries(operations).map( - ([method, operation], operationIndex) => ( - - ) - )} - - ))} -
+ +
+ {loading && } + {Object.entries(paths).map(([endpointPath, operations], pathIndex) => ( + + {Object.entries(operations).map( + ([method, operation], operationIndex) => ( + + ) + )} + + ))} +
+ ) } diff --git a/www/apps/api-reference/components/Tags/Section/Schema/index.tsx b/www/apps/api-reference/components/Tags/Section/Schema/index.tsx index 29a12d258c..0fd67bebd6 100644 --- a/www/apps/api-reference/components/Tags/Section/Schema/index.tsx +++ b/www/apps/api-reference/components/Tags/Section/Schema/index.tsx @@ -1,6 +1,6 @@ "use client" -import { useEffect, useMemo, useRef } from "react" +import { Suspense, useEffect, useMemo, useRef } from "react" import { SchemaObject } from "../../../../types/openapi" import TagOperationParameters from "../../Operation/Parameters" import { @@ -114,41 +114,43 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => { } return ( - - -

{formattedName} Object

-

- Fields -

- - - } - codeContent={ - - {examples.length && ( - - )} - - } - /> - + + + +

{formattedName} Object

+

+ Fields +

+ + + } + codeContent={ + + {examples.length && ( + + )} + + } + /> + + ) } diff --git a/www/apps/api-reference/components/Tags/Section/index.tsx b/www/apps/api-reference/components/Tags/Section/index.tsx index 774dc4d34f..7b86301c53 100644 --- a/www/apps/api-reference/components/Tags/Section/index.tsx +++ b/www/apps/api-reference/components/Tags/Section/index.tsx @@ -1,7 +1,7 @@ "use client" import getSectionId from "@/utils/get-section-id" -import { useInView } from "react-intersection-observer" +import { InView } from "react-intersection-observer" import { useEffect, useMemo, useState } from "react" import { isElmWindow, @@ -65,30 +65,6 @@ const TagSectionComponent = ({ tag }: TagSectionProps) => { return isElmWindow(scrollableElement) ? document.body : scrollableElement }, [scrollableElement, isBrowser]) - const { ref, inView } = useInView({ - threshold: 0.8, - rootMargin: `112px 0px 112px 0px`, - root, - onChange: (inView) => { - if (inView && !loadData) { - setLoadData(true) - } - if (inView) { - // ensure that the hash link doesn't change if it links to an inner path - const currentHashArr = location.hash.replace("#", "").split("_") - if (currentHashArr.length < 2 || currentHashArr[0] !== slugTagName) { - if (location.hash !== slugTagName) { - router.push(`#${slugTagName}`, { - scroll: false, - }) - } - if (activePath !== slugTagName) { - setActivePath(slugTagName) - } - } - } - }, - }) const { data: schemaData } = useSWR<{ schema: SchemaObject }>( @@ -136,10 +112,31 @@ const TagSectionComponent = ({ tag }: TagSectionProps) => { }, [slugTagName, activePath, isBrowser]) return ( -
{ + if (inView) { + if (!loadData) { + setLoadData(true) + } + // ensure that the hash link doesn't change if it links to an inner path + const currentHashArr = location.hash.replace("#", "").split("_") + if (currentHashArr.length < 2 || currentHashArr[0] !== slugTagName) { + if (location.hash !== slugTagName) { + router.push(`#${slugTagName}`, { + scroll: false, + }) + } + if (activePath !== slugTagName) { + setActivePath(slugTagName) + } + } + } + }} > { )} {!loadData && } -
+ ) } diff --git a/www/apps/api-reference/components/Tags/index.tsx b/www/apps/api-reference/components/Tags/index.tsx index baab29971f..881f1a9756 100644 --- a/www/apps/api-reference/components/Tags/index.tsx +++ b/www/apps/api-reference/components/Tags/index.tsx @@ -1,6 +1,7 @@ import { OpenAPIV3 } from "openapi-types" import { TagSectionProps } from "./Section" import dynamic from "next/dynamic" +import { Suspense } from "react" const TagSection = dynamic( async () => import("./Section") @@ -12,11 +13,11 @@ type TagsProps = { const Tags = ({ tags }: TagsProps) => { return ( - <> + {tags?.map((tag) => ( ))} - + ) } diff --git a/www/apps/api-reference/providers/base-specs.tsx b/www/apps/api-reference/providers/base-specs.tsx index b7c0ffca8d..583cc9a3ee 100644 --- a/www/apps/api-reference/providers/base-specs.tsx +++ b/www/apps/api-reference/providers/base-specs.tsx @@ -7,12 +7,13 @@ import { useCallback, useContext, useEffect, + useMemo, } from "react" import { SidebarItem, SidebarItemSections } from "types" import getSectionId from "../utils/get-section-id" import getTagChildSidebarItems from "../utils/get-tag-child-sidebar-items" -import { useRouter } from "next/navigation" -import { useSidebar } from "docs-ui" +import { usePathname, useRouter } from "next/navigation" +import { usePrevious, useSidebar } from "docs-ui" type BaseSpecsContextType = { baseSpecs: ExpandedDocument | undefined @@ -28,7 +29,10 @@ type BaseSpecsProviderProps = { const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { const router = useRouter() - const { activePath, addItems, setActivePath, resetItems } = useSidebar() + const { items, activePath, addItems, setActivePath, resetItems } = + useSidebar() + const pathname = usePathname() + const prevPathName = usePrevious(pathname) const getSecuritySchema = ( securityName: string @@ -49,23 +53,9 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { return null } - const handleOpen = useCallback( - (tagPathName: string) => { - if (location.hash !== tagPathName) { - router.push(`#${tagPathName}`, { - scroll: false, - }) - } - if (activePath !== tagPathName) { - setActivePath(tagPathName) - } - }, - [activePath, router, setActivePath] - ) - - useEffect(() => { + const itemsToAdd = useMemo(() => { if (!baseSpecs) { - return + return [] } const itemsToAdd: SidebarItem[] = [ @@ -88,19 +78,36 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { loaded: childItems.length > 0, showLoadingIfEmpty: true, onOpen: () => { - handleOpen(tagPathName) + if (location.hash !== tagPathName) { + router.push(`#${tagPathName}`, { + scroll: false, + }) + } + if (activePath !== tagPathName) { + setActivePath(tagPathName) + } }, }) }) + return itemsToAdd + }, [baseSpecs]) + + useEffect(() => { + if (!itemsToAdd.length) { + return + } + addItems(itemsToAdd, { section: SidebarItemSections.DEFAULT, }) + }, [itemsToAdd]) + useEffect(() => { return () => { resetItems() } - }, [baseSpecs]) + }, []) return ( { + 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). + +### Parameters + + + +### Returns + + + +___ + +## create + +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. + +### Example + +```ts +sdk.admin.apiKey.create({ + title: "Development", + type: "publishable" +}) +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## revoke + +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. + +### Example + +```ts +sdk.admin.apiKey.revoke("apk_123") +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +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. + +### Example + +```ts +sdk.admin.apiKey.retrieve("apk_123") +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +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. + +### Example + +```ts +sdk.admin.apiKey.update("apk_123", { + title: "Development" +}) +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## delete + +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. + +### Example + +```ts +sdk.admin.apiKey.delete("apk_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## batchSalesChannels + +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. + +### Example + +```ts +sdk.admin.apiKey.batchSalesChannels("apk_123", { + add: ["sc_123"], + remove: ["sc_321"] +}) +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx new file mode 100644 index 0000000000..b93f0d0c53 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx @@ -0,0 +1,193 @@ +--- +slug: /references/js-sdk/admin/campaign +sidebar_label: campaign +--- + +import { TypeList } from "docs-ui" + +# campaign - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.campaign` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +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. + +### 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). + +### Parameters + + + +### Returns + + + +___ + +## list + +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. + +### 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). + +### Parameters + + + +### Returns + + + +___ + +## create + +This method creates a campaign. It sends a request to the +[Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns\_postcampaigns) API route. + +### Example + +```ts +sdk.admin.campaign.create({ + name: "Summer Campaign" +}) +.then(({ campaign }) => { + console.log(campaign) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +This method updates a campaign. It sends a request to the +[Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns\_postcampaignsid) API route. + +### Example + +```ts +sdk.admin.campaign.update("procamp_123", { + name: "Summer Campaign" +}) +.then(({ campaign }) => { + console.log(campaign) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## delete + +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. + +### Example + +```ts +sdk.admin.campaign.delete("procamp_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## batchPromotions + +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. + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx new file mode 100644 index 0000000000..1f84990ec5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx @@ -0,0 +1,696 @@ +--- +slug: /references/js-sdk/admin/claim +sidebar_label: claim +--- + +import { TypeList } from "docs-ui" + +# claim - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.claim` set of methods used to send requests to Medusa's Admin API routes. + +## list + +This method retrieves a paginated list of claims. It sends a request to the +[List Claims](https://docs.medusajs.com/v2/api/admin#claims\_getclaims) API route. + +### Example + +To retrieve the list of claims: + +```ts +sdk.admin.claim.list() +.then(({ claims, count, limit, offset }) => { + console.log(claims) +}) +``` + +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.claim.list({ + limit: 10, + offset: 10 +}) +.then(({ claims, count, limit, offset }) => { + console.log(claims) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each claim: + +```ts +sdk.admin.claim.list({ + fields: "id,*additional_items" +}) +.then(({ claims, count, limit, offset }) => { + console.log(claims) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## retrieve + +This method retrieves a claim. It sends a request to the +[Get Claim](https://docs.medusajs.com/v2/api/admin#claims\_getclaimsid) API route. + +### Example + +To retrieve a claim by its ID: + +```ts +sdk.admin.claim.retrieve("claim_123") +.then(({ claim }) => { + console.log(claim) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.claim.retrieve("claim_123", { + fields: "id,*additional_items" +}) +.then(({ claim }) => { + console.log(claim) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## create + +This method creates a claim. It sends a request to the +[Create Claim](https://docs.medusajs.com/v2/api/admin#claims\_postclaims) API route. + +### Example + +```ts +sdk.admin.claim.create({ + type: "refund", + order_id: "order_123", +}) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## cancel + +This method cancels a claim. It sends a request to the +[Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidcancel) API route. + +### Example + +```ts +sdk.admin.claim.cancel("claim_123") +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/> + +___ + +## addItems + +This method adds items to the claim. It sends a request to the +[Add Items](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidclaimitems) API route. + +### Example + +```ts +sdk.admin.claim.addItems("claim_123", { + items: [ + { + id: "orli_123", + quantity: 1 + } + ] +}) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/> + +___ + +## updateItem + +This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It +sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidclaimitemsaction\_id) API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.updateItem( + "claim_123", + "ordchact_123", + { + quantity: 1 + } + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateItem"/> + +___ + +## removeItem + +This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action. +It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidclaimitemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.removeItem( + "claim_123", + "ordchact_123", + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeItem"/> + +___ + +## addInboundItems + +This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action. + +This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinbounditems) +API route. + +### Example + +```ts +sdk.admin.claim.addInboundItems( + "claim_123", + { + items: [ + { + id: "orli_123", + quantity: 1 + } + ] + }, + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## updateInboundItem + +This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action. +It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.updateInboundItem( + "claim_123", + "ordchact_123", + { + quantity: 1 + }, + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## removeInboundItem + +This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action. +It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidinbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.removeInboundItem( + "claim_123", + "ordchact_123", + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## addInboundShipping + +This method adds an inbound (or return) shipping method to a claim. +The inbound shipping method will have a `SHIPPING_ADD` action. + +This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinboundshippingmethod) +API route. + +### Example + +```ts +sdk.admin.claim.addInboundShipping( + "claim_123", + { + shipping_option_id: "so_123", + custom_amount: 10 + }, + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/> + +### Returns + + + +___ + +## updateInboundShipping + +This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action. +It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinboundshippingmethodaction\_id) +API route. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.updateInboundShipping( + "claim_123", + "ordchact_123", + { + custom_amount: 10 + }, + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/> + +___ + +## deleteInboundShipping + +This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action. +It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidinboundshippingmethodaction\_id) +API route. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.deleteInboundShipping( + "claim_123", + "ordchact_123", + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## addOutboundItems + +This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action. +It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutbounditems) +API route. + +### Example + +```ts +sdk.admin.claim.addOutboundItems( + "claim_123", + { + items: [{ + id: "orli_123", + quantity: 1 + }] + }, + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/> + +___ + +## updateOutboundItem + +This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action. +It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.updateOutboundItem( + "claim_123", + "ordchact_123", + { + quantity: 1 + }, + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/> + +___ + +## removeOutboundItem + +This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action. +It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidoutbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.removeOutboundItem( + "claim_123", + "ordchact_123", +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/> + +___ + +## addOutboundShipping + +This method adds outbound an outbound shipping method to a claim. +The outbound shipping method will have a `SHIPPING_ADD` action. + +This method sends a request to the +[Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutboundshippingmethod) +API route. + +### Example + +```ts +* sdk.admin.claim.addOutboundShipping( + "claim_123", + { + shipping_option_id: "so_123", + custom_amount: 10 + }, +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> + +___ + +## updateOutboundShipping + +This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action. +It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutboundshippingmethodaction\_id) +API route. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.updateOutboundShipping( + "claim_123", + "ordchact_123", + { + custom_amount: 10 + }, +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> + +___ + +## deleteOutboundShipping + +This method deletes the shipping method for delivering outbound items in the claim using the ID of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +### Example + +```ts +sdk.admin.claim.deleteOutboundShipping( + "claim_123", + "ordchact_123", +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/> + +___ + +## request + +This method confirms a claim request, applying its changes on the associated order. +It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidrequest) +API route. + +### Example + +```ts +sdk.admin.claim.request( + "claim_123", + {}, +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="request"/> + +___ + +## cancelRequest + +This method cancels a requested claim. It sends a request to the +[Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidrequest) +API route. + +### Example + +```ts +sdk.admin.claim.cancelRequest( + "claim_123", +) +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx new file mode 100644 index 0000000000..0bb82786be --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx @@ -0,0 +1,102 @@ +--- +slug: /references/js-sdk/admin/currency +sidebar_label: currency +--- + +import { TypeList } from "docs-ui" + +# currency - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.currency` set of methods used to send requests to Medusa's Admin API routes. + +## list + +This method retrieves a paginated list of currencies. It sends a request to the +[List Currencies](https://docs.medusajs.com/v2/api/admin#currencies\_getcurrencies) +API route. + +### Example + +To retrieve the list of currencies: + +```ts +sdk.admin.currency.list() +.then(({ currencies, count, limit, offset }) => { + console.log(currencies) +}) +``` + +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.currency.list({ + limit: 10, + offset: 10 +}) +.then(({ currencies, count, limit, offset }) => { + console.log(currencies) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each currency: + +```ts +sdk.admin.currency.list({ + fields: "code,symbol" +}) +.then(({ currencies, count, limit, offset }) => { + console.log(currencies) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a currency by its code. It sends a request to the +[Get Currency](https://docs.medusajs.com/v2/api/admin#currencies\_getcurrenciescode) API route. + +### Example + +To retrieve a currency by its code: + +```ts +sdk.admin.currency.retrieve("usd") +.then(({ currency }) => { + console.log(currency) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.currency.retrieve("usd", { + fields: "code,symbol" +}) +.then(({ currency }) => { + console.log(currency) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx new file mode 100644 index 0000000000..43349dbf67 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx @@ -0,0 +1,180 @@ +--- +slug: /references/js-sdk/admin/customer +sidebar_label: customer +--- + +import { TypeList } from "docs-ui" + +# customer - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.customer` set of methods used to send requests to Medusa's Admin API routes. + +## create + +This method creates a customer. It sends a request to the +[Create Customer](https://docs.medusajs.com/v2/api/admin#customers\_postcustomers) API route. + +### Example + +```ts +sdk.admin.customer.create({ + email: "customer@gmail.com" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +This method updates a customer's details. It sends a request to the +[Update Customer](https://docs.medusajs.com/v2/api/admin#customers\_postcustomersid) API route. + +### Example + +```ts +sdk.admin.customer.update("cus_123", { + first_name: "John" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## list + +This method retrieves a paginated list of customers. It sends a request to the +[List Customers](https://docs.medusajs.com/v2/api/admin#customers\_getcustomers) +API route. + +### Example + +To retrieve the list of customers: + +```ts +sdk.admin.customer.list() +.then(({ customers, count, limit, offset }) => { + console.log(customers) +}) +``` + +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.customer.list({ + limit: 10, + offset: 10 +}) +.then(({ customers, count, limit, offset }) => { + console.log(customers) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each customer: + +```ts +sdk.admin.customer.list({ + fields: "id,*groups" +}) +.then(({ customers, count, limit, offset }) => { + console.log(customers) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a customer by its ID. It sends a request to the +[Get Customer](https://docs.medusajs.com/v2/api/admin#customers\_getcustomersid) +API route. + +### Example + +To retrieve a customer by its ID: + +```ts +sdk.admin.customer.retrieve("cus_123") +.then(({ customer }) => { + console.log(customer) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.customer.retrieve("cus_123", { + fields: "id,*groups" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## delete + +This method deletes a customer by its ID. It sends a request to the +[Delete Customer](https://docs.medusajs.com/v2/api/admin#customers\_deletecustomersid) +API route. + +### Example + +```ts +sdk.admin.customer.delete("cus_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx new file mode 100644 index 0000000000..efc81118c6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx @@ -0,0 +1,209 @@ +--- +slug: /references/js-sdk/admin/customerGroup +sidebar_label: customerGroup +--- + +import { TypeList } from "docs-ui" + +# customerGroup - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.customerGroup` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +This method retrieves a customer group by its ID. It sends a request to the +[Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups\_getcustomergroupsid) API route. + +### Example + +To retrieve a customer group by its ID: + +```ts +sdk.admin.customerGroup.retrieve("cusgroup_123") +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.customerGroup.retrieve("cusgroup_123", { + fields: "id,*customer" +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## list + +This method retrieves a paginated list of customer groups. It sends a request to the +[List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups\_getcustomergroups) +API route. + +### Example + +To retrieve the list of customer groups: + +```ts +sdk.admin.customerGroup.list() +.then(({ customer_groups, count, limit, offset }) => { + console.log(customer_groups) +}) +``` + +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.customerGroup.list({ + limit: 10, + offset: 10 +}) +.then(({ customer_groups, count, limit, offset }) => { + console.log(customer_groups) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each customer group: + +```ts +sdk.admin.customerGroup.list({ + fields: "id,*customer" +}) +.then(({ customer_groups, count, limit, offset }) => { + console.log(customer_groups) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## create + +This method creates a customer group. It sends a request to the +[Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups\_postcustomergroups) +API route. + +### Example + +```ts +sdk.admin.customerGroup.create({ + name: "VIP" +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetCustomerGroupParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupParams/page.mdx)","description":"Configure the fields to retrieve in the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +This method updates a customer group's details. It sends a request to the +[Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups\_postcustomergroupsid) +API route. + +### Example + +```ts +sdk.admin.customerGroup.update("cusgroup_123", { + name: "VIP" +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetCustomerGroupParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupParams/page.mdx)","description":"Configure the fields to retrieve in the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +This method deletes a customer group. This method sends a request to the +[Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups\_deletecustomergroupsid) +API route. + +### Example + +```ts +sdk.admin.customerGroup.delete("cusgroup_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## batchCustomers + +This method manages customers of a group to add or remove them from the group. +It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups\_postcustomergroupsidcustomers) +API route. + +### Example + +```ts +sdk.admin.customerGroup.batchCustomers("cusgroup_123", { + add: ["cus_123"], + remove: ["cus_321"] +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchCustomers"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.exchange/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.exchange/page.mdx new file mode 100644 index 0000000000..66f1610314 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.exchange/page.mdx @@ -0,0 +1,605 @@ +--- +slug: /references/js-sdk/admin/exchange +sidebar_label: exchange +--- + +import { TypeList } from "docs-ui" + +# exchange - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.exchange` set of methods used to send requests to Medusa's Admin API routes. + +## list + +This method retrieves a paginated list of exchanges. It sends a request to the +[List Exchanges](https://docs.medusajs.com/v2/api/admin#exchanges\_getexchanges) +API route. + +### Example + +To retrieve the list of exchanges: + +```ts +sdk.admin.exchange.list() +.then(({ exchanges, count, limit, offset }) => { + console.log(exchanges) +}) +``` + +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.exchange.list({ + limit: 10, + offset: 10 +}) +.then(({ exchanges, count, limit, offset }) => { + console.log(exchanges) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each exchange: + +```ts +sdk.admin.exchange.list({ + fields: "id,*order" +}) +.then(({ exchanges, count, limit, offset }) => { + console.log(exchanges) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves an exchange by its ID. It sends a request to the +[Get Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_getexchangesid) +API route. + +### Example + +To retrieve an exchange by its ID: + +```ts +sdk.admin.exchange.retrieve("exchange_123") +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.exchange.retrieve("exchange_123", { + fields: "id,*order" +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## create + +This method creates an admin exchange. It sends a request to the +[Create Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchanges) API route. + +### Example + +```ts +sdk.admin.exchange.create({ + order_id: "order_123" +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## cancel + +This method cancels an exchange. It sends a request to the +[Cancel Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidcancel) API route. + +### Example + +```ts +sdk.admin.exchange.cancel("exchange_123") +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/> + +___ + +## addInboundItems + +This method adds inbound (or return) items to an exchange. These inbound items will +have the action `RETURN_ITEM`. + +This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinbounditems) +API route. + +### Example + +```ts +sdk.admin.exchange.addInboundItems("exchange_123", { + items: [{ + id: "orli_123", + quantity: 1 + }] +}) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## updateInboundItem + +This method updates an inbound (or return) item from an exchange using the ID of +the item's `RETURN_ITEM` action. + +Every item has an `actions` property, whose value is an array of actions. You can +check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinbounditemsaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.updateInboundItem( + "exchange_123", + "ordchact_123", + { + quantity: 1 + } +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## removeInboundItem + +This method removes an inbound (or return) item from an exchange using the ID of the +item's `RETURN_ITEM` action. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidinbounditemsaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.removeInboundItem( + "exchange_123", + "ordchact_123", +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## addInboundShipping + +This method adds an inbound (or return) shipping method to an exchange. +The inbound shipping method will have a `SHIPPING_ADD` action. + +This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinboundshippingmethod) +API route. + +This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinboundshippingmethod) +API route. + +### Example + +```ts +sdk.admin.exchange.addInboundShipping("exchange_123", { + shipping_option_id: "so_123" +}) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/> + +### Returns + + + +___ + +## updateInboundShipping + +This method updates the shipping method for returning items in the exchange using the ID +of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinboundshippingmethodaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.updateInboundShipping( + "exchange_123", + "ordchact_123", + { + custom_amount: 10 + } +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/> + +### Returns + + + +___ + +## deleteInboundShipping + +This method removes the shipping method for returning items in the exchange using the ID +of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidinboundshippingmethodaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.deleteInboundShipping( + "exchange_123", + "ordchact_123", +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## addOutboundItems + +This method adds outbound (or new) items to an exchange. +These outbound items will have the action `ITEM_ADD`. + +This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutbounditems) +API route. + +### Example + +```ts +sdk.admin.exchange.addOutboundItems("exchange_123", { + items: [{ + id: "variant_123", + quantity: 1 + }] +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/> + +___ + +## updateOutboundItem + +This method updates an outbound (or new) item from an exchange using the ID +of the item's `ITEM_ADD` action. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutbounditemsaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.updateOutboundItem( + "exchange_123", + "ordchact_123", + { + quantity: 1 + } +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/> + +___ + +## removeOutboundItem + +This method removes an outbound (or new) item from an exchange using the ID +of the item's `ITEM_ADD` action. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidoutbounditemsaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.removeOutboundItem( + "exchange_123", + "ordchact_123", +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/> + +___ + +## addOutboundShipping + +This method adds an outbound shipping method to an exchange. The outbound shipping method +will have a `SHIPPING_ADD` action. + +This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutboundshippingmethod) +API route. + +### Example + +```ts +sdk.admin.exchange.addOutboundShipping("exchange_123", { + shipping_option_id: "so_123" +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> + +___ + +## updateOutboundShipping + +This method updates the shipping method for delivering outbound items in the exchange using +the ID of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutboundshippingmethodaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.updateOutboundShipping( + "exchange_123", + "ordchact_123", + { + custom_amount: 10 + } +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> + +___ + +## deleteOutboundShipping + +This method removes the shipping method for delivering outbound items in the exchange using +the ID of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidoutboundshippingmethodaction\_id) +API route. + +### Example + +```ts +sdk.admin.exchange.deleteOutboundShipping( + "exchange_123", + "ordchact_123", +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/> + +___ + +## request + +This method confirms an exchange request, applying its changes on the associated order. + +This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidrequest) +API route. + +### Example + +```ts +sdk.admin.exchange.request("exchange_123", {}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="request"/> + +___ + +## cancelRequest + +This method cancels an exchange request. It sends a request to the +[Cancel Exchange Request](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidrequest) +API route. + +### Example + +```ts +sdk.admin.exchange.cancel("exchange_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillment/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillment/page.mdx new file mode 100644 index 0000000000..bcdb740e3b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillment/page.mdx @@ -0,0 +1,44 @@ +--- +slug: /references/js-sdk/admin/fulfillment +sidebar_label: fulfillment +--- + +import { TypeList } from "docs-ui" + +# fulfillment - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.fulfillment` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + + + +### Returns + + + +___ + +## cancel + +### Parameters + + + +### Returns + + + +___ + +## createShipment + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx new file mode 100644 index 0000000000..cd1b1d2493 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx @@ -0,0 +1,63 @@ +--- +slug: /references/js-sdk/admin/fulfillmentProvider +sidebar_label: fulfillmentProvider +--- + +import { TypeList } from "docs-ui" + +# fulfillmentProvider - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.fulfillmentProvider` set of methods used to send requests to Medusa's Admin API routes. + +## list + +This method retrieves a paginated list of fulfillment providers. It sends a request to the +[List Fulfillment Providers](https://docs.medusajs.com/v2/api/admin#fulfillment-providers\_getfulfillmentproviders) +API route. + +### Example + +To retrieve the list of fulfillment providers: + +```ts +sdk.admin.fulfillmentProvider.list() +.then(({ fulfillment_providers, count, limit, offset }) => { + console.log(fulfillment_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.fulfillmentProvider.list({ + limit: 10, + offset: 10 +}) +.then(({ fulfillment_providers, count, limit, offset }) => { + console.log(fulfillment_providers) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each fulfillment provider: + +```ts +sdk.admin.fulfillmentProvider.list({ + fields: "id" +}) +.then(({ fulfillment_providers, count, limit, offset }) => { + console.log(fulfillment_providers) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx new file mode 100644 index 0000000000..cfcc7965ff --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/fulfillmentSet +sidebar_label: fulfillmentSet +--- + +import { TypeList } from "docs-ui" + +# fulfillmentSet - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.fulfillmentSet` set of methods used to send requests to Medusa's Admin API routes. + +## delete + +### Parameters + + + +### Returns + + + +___ + +## createServiceZone + +### Parameters + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createServiceZone"/> + +### Returns + + + +___ + +## retrieveServiceZone + +### Parameters + + + +### Returns + + + +___ + +## updateServiceZone + +### Parameters + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateServiceZone"/> + +### Returns + + + +___ + +## deleteServiceZone + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx new file mode 100644 index 0000000000..455c78ead2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx @@ -0,0 +1,116 @@ +--- +slug: /references/js-sdk/admin/inventoryItem +sidebar_label: inventoryItem +--- + +import { TypeList } from "docs-ui" + +# inventoryItem - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.inventoryItem` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## list + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"`Record<\"location_id\", string \\| string[]>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"length","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"height","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location_levels","type":"`Record<\"location_id\", string \\| string[]>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## listLevels + +### Parameters + + + +### Returns + + + +___ + +## updateLevel + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateLevel"/> + +___ + +## deleteLevel + +### Parameters + + + +### Returns + + + +___ + +## batchUpdateLevels + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx new file mode 100644 index 0000000000..73dfbb9fbc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx @@ -0,0 +1,80 @@ +--- +slug: /references/js-sdk/admin/invite +sidebar_label: invite +--- + +import { TypeList } from "docs-ui" + +# invite - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.invite` set of methods used to send requests to Medusa's Admin API routes. + +## accept + +### Parameters + + + +### Returns + + + +___ + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## resend + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx new file mode 100644 index 0000000000..a76d367903 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx @@ -0,0 +1,32 @@ +--- +slug: /references/js-sdk/admin/notification +sidebar_label: notification +--- + +import { TypeList } from "docs-ui" + +# notification - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.notification` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx new file mode 100644 index 0000000000..e4604b1ea9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx @@ -0,0 +1,128 @@ +--- +slug: /references/js-sdk/admin/order +sidebar_label: order +--- + +import { TypeList } from "docs-ui" + +# order - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.order` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## retrievePreview + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## cancel + +### Parameters + + + +### Returns + + + +___ + +## createFulfillment + +### Parameters + + + +### Returns + + + +___ + +## cancelFulfillment + +### Parameters + + + +### Returns + + + +___ + +## createShipment + +### Parameters + + + +### Returns + + + +___ + +## markAsDelivered + +### Parameters + + + +### Returns + + + +___ + +## listChanges + +### Parameters + + + +### Returns + + + +___ + +## listLineItems + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx new file mode 100644 index 0000000000..818276a94b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx @@ -0,0 +1,104 @@ +--- +slug: /references/js-sdk/admin/orderEdit +sidebar_label: orderEdit +--- + +import { TypeList } from "docs-ui" + +# orderEdit - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.orderEdit` set of methods used to send requests to Medusa's Admin API routes. + +## initiateRequest + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initiateRequest"/> + +### Returns + + + +___ + +## request + +### Parameters + + + +### Returns + + + +___ + +## confirm + +### Parameters + + + +### Returns + + + +___ + +## cancelRequest + +### Parameters + + + +### Returns + + + +___ + +## addItems + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/> + +### Returns + + + +___ + +## updateOriginalItem + +### Parameters + + + +### Returns + + + +___ + +## updateAddedItem + +### Parameters + + + +### Returns + + + +___ + +## removeAddedItem + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx new file mode 100644 index 0000000000..28075d2888 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/payment +sidebar_label: payment +--- + +import { TypeList } from "docs-ui" + +# payment - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.payment` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + + + +### Returns + + + +___ + +## listPaymentProviders + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## capture + +### Parameters + + + +### Returns + + + +___ + +## refund + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx new file mode 100644 index 0000000000..b67c306d26 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/paymentCollection +sidebar_label: paymentCollection +--- + +import { TypeList } from "docs-ui" + +# paymentCollection - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.paymentCollection` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## create + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## markAsPaid + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.priceList/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.priceList/page.mdx new file mode 100644 index 0000000000..9d63b07d0f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.priceList/page.mdx @@ -0,0 +1,92 @@ +--- +slug: /references/js-sdk/admin/priceList +sidebar_label: priceList +--- + +import { TypeList } from "docs-ui" + +# priceList - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.priceList` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminCreatePriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePriceListPrice/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[AdminPriceListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminPriceListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## batchPrices + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[AdminUpdatePriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePriceListPrice/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminPriceListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPrices"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPrices"/> + +___ + +## linkProducts + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkProducts"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx new file mode 100644 index 0000000000..f9b14a2b54 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/pricePreference +sidebar_label: pricePreference +--- + +import { TypeList } from "docs-ui" + +# pricePreference - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.pricePreference` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## create + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx new file mode 100644 index 0000000000..6afca467f9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx @@ -0,0 +1,260 @@ +--- +slug: /references/js-sdk/admin/product +sidebar_label: product +--- + +import { TypeList } from "docs-ui" + +# product - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.product` set of methods used to send requests to Medusa's Admin API routes. + +## import + +### Parameters + + + +### Returns + + + +___ + +## confirmImport + +### Parameters + + + +### Returns + + + +___ + +## export + +### Parameters + + + +### Returns + + + +___ + +## batch + +### Parameters + + + +### Returns + + + +___ + +## create + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## batchVariants + +### Parameters + + + +### Returns + + + +___ + +## createVariant + +### Parameters + + + +### Returns + + + +___ + +## updateVariant + +### Parameters + + + +### Returns + + + +___ + +## listVariants + +### Parameters + + + +### Returns + + + +___ + +## retrieveVariant + +### Parameters + + + +### Returns + + + +___ + +## deleteVariant + +### Parameters + + + +### Returns + + + +___ + +## batchVariantInventoryItems + +### Parameters + + + +### Returns + + + +___ + +## createOption + +### Parameters + + + +### Returns + + + +___ + +## updateOption + +### Parameters + + + +### Returns + + + +___ + +## listOptions + +### Parameters + + + +### Returns + + + +___ + +## retrieveOption + +### Parameters + + + +### Returns + + + +___ + +## deleteOption + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx new file mode 100644 index 0000000000..c55b0ebb33 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx @@ -0,0 +1,80 @@ +--- +slug: /references/js-sdk/admin/productCategory +sidebar_label: productCategory +--- + +import { TypeList } from "docs-ui" + +# productCategory - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.productCategory` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductCategoryParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductCategoryParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## updateProducts + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProducts"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx new file mode 100644 index 0000000000..7bdf383a1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx @@ -0,0 +1,80 @@ +--- +slug: /references/js-sdk/admin/productCollection +sidebar_label: productCollection +--- + +import { TypeList } from "docs-ui" + +# productCollection - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.productCollection` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminCollectionParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminCollectionParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## updateProducts + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProducts"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx new file mode 100644 index 0000000000..a607d35ece --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productTag/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/productTag +sidebar_label: productTag +--- + +import { TypeList } from "docs-ui" + +# productTag - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.productTag` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductTagParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductTagParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx new file mode 100644 index 0000000000..8e4b610d99 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productType/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/productType +sidebar_label: productType +--- + +import { TypeList } from "docs-ui" + +# productType - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.productType` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx new file mode 100644 index 0000000000..ff11be450c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/js-sdk/admin/productVariant +sidebar_label: productVariant +--- + +import { TypeList } from "docs-ui" + +# productVariant - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.productVariant` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx new file mode 100644 index 0000000000..fd53fcc3ad --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.promotion/page.mdx @@ -0,0 +1,140 @@ +--- +slug: /references/js-sdk/admin/promotion +sidebar_label: promotion +--- + +import { TypeList } from "docs-ui" + +# promotion - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.promotion` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## create + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## addRules + +### Parameters + + + +### Returns + + + +___ + +## updateRules + +### Parameters + + + +### Returns + + + +___ + +## removeRules + +### Parameters + + + +### Returns + + + +___ + +## listRules + +### Parameters + + + +### Returns + + + +___ + +## listRuleAttributes + +### Parameters + + + +### Returns + + + +___ + +## listRuleValues + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx new file mode 100644 index 0000000000..c48ab6302f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/js-sdk/admin/refundReason +sidebar_label: refundReason +--- + +import { TypeList } from "docs-ui" + +# refundReason - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.refundReason` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx new file mode 100644 index 0000000000..57f88b72c7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.region/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/region +sidebar_label: region +--- + +import { TypeList } from "docs-ui" + +# region - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.region` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx new file mode 100644 index 0000000000..b8d30ca3e4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.reservation/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/reservation +sidebar_label: reservation +--- + +import { TypeList } from "docs-ui" + +# reservation - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.reservation` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetReservationsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetReservationsParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetReservationsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetReservationsParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.return/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.return/page.mdx new file mode 100644 index 0000000000..cfe01dc81d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.return/page.mdx @@ -0,0 +1,272 @@ +--- +slug: /references/js-sdk/admin/return +sidebar_label: return +--- + +import { TypeList } from "docs-ui" + +# return - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.return` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + +` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<Record<string, unknown>>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## initiateRequest + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initiateRequest"/> + +### Returns + + + +___ + +## cancel + +### Parameters + + + +### Returns + + + +___ + +## cancelRequest + +### Parameters + + + +### Returns + + + +___ + +## addReturnItem + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addReturnItem"/> + +### Returns + + + +___ + +## updateReturnItem + +### Parameters + + + +### Returns + + + +___ + +## removeReturnItem + +### Parameters + + + +### Returns + + + +___ + +## addReturnShipping + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addReturnShipping"/> + +### Returns + + + +___ + +## updateReturnShipping + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnShipping"/> + +### Returns + + + +___ + +## deleteReturnShipping + +### Parameters + + + +### Returns + + + +___ + +## updateRequest + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRequest"/> + +### Returns + + + +___ + +## confirmRequest + +### Parameters + + + +### Returns + + + +___ + +## initiateReceive + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initiateReceive"/> + +### Returns + + + +___ + +## receiveItems + +### Parameters + + + +### Returns + + + +___ + +## updateReceiveItem + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReceiveItem"/> + +### Returns + + + +___ + +## removeReceiveItem + +### Parameters + + + +### Returns + + + +___ + +## dismissItems + +### Parameters + + + +### Returns + + + +___ + +## updateDismissItem + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateDismissItem"/> + +### Returns + + + +___ + +## removeDismissItem + +### Parameters + + + +### Returns + + + +___ + +## confirmReceive + +### Parameters + + + +### Returns + + + +___ + +## cancelReceive + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx new file mode 100644 index 0000000000..f7f9aa73f5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/returnReason +sidebar_label: returnReason +--- + +import { TypeList } from "docs-ui" + +# returnReason - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.returnReason` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminReturnReasonParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminReturnReasonParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx new file mode 100644 index 0000000000..be9aa261a9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx @@ -0,0 +1,92 @@ +--- +slug: /references/js-sdk/admin/salesChannel +sidebar_label: salesChannel +--- + +import { TypeList } from "docs-ui" + +# salesChannel - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.salesChannel` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## updateProducts + +### Parameters + + + +### Returns + + + +___ + +## batchProducts + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx new file mode 100644 index 0000000000..994f71ba01 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx @@ -0,0 +1,80 @@ +--- +slug: /references/js-sdk/admin/shippingOption +sidebar_label: shippingOption +--- + +import { TypeList } from "docs-ui" + +# shippingOption - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.shippingOption` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminCreateShippingOptionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateShippingOptionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[AdminCreateShippingOptionType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateShippingOptionType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"([AdminUpdateShippingOptionPriceWithCurrency](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionPriceWithCurrency/page.mdx) \\| [AdminUpdateShippingOptionPriceWithRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionPriceWithRegion/page.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"([AdminCreateShippingOptionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateShippingOptionRule/page.mdx) \\| [AdminUpdateShippingOptionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionRule/page.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## updateRules + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx new file mode 100644 index 0000000000..1388f045dc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/shippingProfile +sidebar_label: shippingProfile +--- + +import { TypeList } from "docs-ui" + +# shippingProfile - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.shippingProfile` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx new file mode 100644 index 0000000000..53fc876ae1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx @@ -0,0 +1,104 @@ +--- +slug: /references/js-sdk/admin/stockLocation +sidebar_label: stockLocation +--- + +import { TypeList } from "docs-ui" + +# stockLocation - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.stockLocation` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + + + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## updateSalesChannels + +### Parameters + + + +### Returns + + + +___ + +## createFulfillmentSet + +### Parameters + + + +### Returns + + + +___ + +## updateFulfillmentProviders + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.store/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.store/page.mdx new file mode 100644 index 0000000000..c29439a830 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.store/page.mdx @@ -0,0 +1,44 @@ +--- +slug: /references/js-sdk/admin/store +sidebar_label: store +--- + +import { TypeList } from "docs-ui" + +# store - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.store` set of methods used to send requests to Medusa's Admin API routes. + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx new file mode 100644 index 0000000000..321d0a446b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx @@ -0,0 +1,68 @@ +--- +slug: /references/js-sdk/admin/taxRate +sidebar_label: taxRate +--- + +import { TypeList } from "docs-ui" + +# taxRate - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.taxRate` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminTaxRateRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## update + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminTaxRateRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminTaxRateRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## list + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx new file mode 100644 index 0000000000..b55a6f6195 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx @@ -0,0 +1,56 @@ +--- +slug: /references/js-sdk/admin/taxRegion +sidebar_label: taxRegion +--- + +import { TypeList } from "docs-ui" + +# taxRegion - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.taxRegion` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"[AdminTaxRate](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRate/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`null` \\| [AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"[AdminTaxRate](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRate/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`null` \\| [AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> + +___ + +## list + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.upload/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.upload/page.mdx new file mode 100644 index 0000000000..3fc8102519 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.upload/page.mdx @@ -0,0 +1,44 @@ +--- +slug: /references/js-sdk/admin/upload +sidebar_label: upload +--- + +import { TypeList } from "docs-ui" + +# upload - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.upload` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.user/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.user/page.mdx new file mode 100644 index 0000000000..45ceb54d71 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.user/page.mdx @@ -0,0 +1,80 @@ +--- +slug: /references/js-sdk/admin/user +sidebar_label: user +--- + +import { TypeList } from "docs-ui" + +# user - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.user` set of methods used to send requests to Medusa's Admin API routes. + +## create + +### Parameters + + + +### Returns + + + +___ + +## update + +### Parameters + + + +### Returns + + + +___ + +## list + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + + +___ + +## delete + +### Parameters + + + +### Returns + + + +___ + +## me + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx new file mode 100644 index 0000000000..52b9311e1f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx @@ -0,0 +1,32 @@ +--- +slug: /references/js-sdk/admin/workflowExecution +sidebar_label: workflowExecution +--- + +import { TypeList } from "docs-ui" + +# workflowExecution - JS SDK Admin Reference + +This documentation provides a reference to the `sdk.admin.workflowExecution` set of methods used to send requests to Medusa's Admin API routes. + +## list + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/page.mdx new file mode 100644 index 0000000000..18de4b0342 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/page.mdx @@ -0,0 +1,27 @@ +import { TypeList } from "docs-ui" + +# batchSalesChannels + +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. + +## Example + +```ts +sdk.admin.apiKey.batchSalesChannels("apk_123", { + add: ["sc_123"], + remove: ["sc_321"] +}) +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx new file mode 100644 index 0000000000..cd09df4c41 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx @@ -0,0 +1,26 @@ +import { TypeList } from "docs-ui" + +# create + +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. + +## Example + +```ts +sdk.admin.apiKey.create({ + title: "Development", + type: "publishable" +}) +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/page.mdx new file mode 100644 index 0000000000..0be27a29be --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/page.mdx @@ -0,0 +1,23 @@ +import { TypeList } from "docs-ui" + +# delete + +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. + +## Example + +```ts +sdk.admin.apiKey.delete("apk_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx new file mode 100644 index 0000000000..0459f185b4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx @@ -0,0 +1,53 @@ +import { TypeList } from "docs-ui" + +# list + +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. + +## 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). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/page.mdx new file mode 100644 index 0000000000..0f5f82b7f8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/page.mdx @@ -0,0 +1,23 @@ +import { TypeList } from "docs-ui" + +# retrieve + +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. + +## Example + +```ts +sdk.admin.apiKey.retrieve("apk_123") +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/page.mdx new file mode 100644 index 0000000000..5b5b047950 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/page.mdx @@ -0,0 +1,23 @@ +import { TypeList } from "docs-ui" + +# revoke + +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. + +## Example + +```ts +sdk.admin.apiKey.revoke("apk_123") +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx new file mode 100644 index 0000000000..7729151dcb --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# update + +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. + +## Example + +```ts +sdk.admin.apiKey.update("apk_123", { + title: "Development" +}) +.then(({ api_key }) => { + console.log(api_key) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ApiKey/properties/js_sdk.admin.ApiKey.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ApiKey/properties/js_sdk.admin.ApiKey.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ApiKey/properties/js_sdk.admin.ApiKey.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.batchPromotions/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.batchPromotions/page.mdx new file mode 100644 index 0000000000..f8fd09bb60 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.batchPromotions/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# batchPromotions + +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. + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/page.mdx new file mode 100644 index 0000000000..6b387168e4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# create + +This method creates a campaign. It sends a request to the +[Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns\_postcampaigns) API route. + +## Example + +```ts +sdk.admin.campaign.create({ + name: "Summer Campaign" +}) +.then(({ campaign }) => { + console.log(campaign) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.delete/page.mdx new file mode 100644 index 0000000000..d53116918e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.delete/page.mdx @@ -0,0 +1,23 @@ +import { TypeList } from "docs-ui" + +# delete + +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. + +## Example + +```ts +sdk.admin.campaign.delete("procamp_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/page.mdx new file mode 100644 index 0000000000..88bb6de11f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/page.mdx @@ -0,0 +1,53 @@ +import { TypeList } from "docs-ui" + +# list + +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. + +## 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). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.retrieve/page.mdx new file mode 100644 index 0000000000..6431684c22 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.retrieve/page.mdx @@ -0,0 +1,38 @@ +import { TypeList } from "docs-ui" + +# retrieve + +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. + +## 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). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/page.mdx new file mode 100644 index 0000000000..4c7ab493db --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# update + +This method updates a campaign. It sends a request to the +[Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns\_postcampaignsid) API route. + +## Example + +```ts +sdk.admin.campaign.update("procamp_123", { + name: "Summer Campaign" +}) +.then(({ campaign }) => { + console.log(campaign) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Campaign/properties/js_sdk.admin.Campaign.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Campaign/properties/js_sdk.admin.Campaign.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Campaign/properties/js_sdk.admin.Campaign.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/page.mdx new file mode 100644 index 0000000000..37448b2ee6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/page.mdx @@ -0,0 +1,35 @@ +import { TypeList } from "docs-ui" + +# addInboundItems + +This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action. + +This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinbounditems) +API route. + +## Example + +```ts +sdk.admin.claim.addInboundItems( + "claim_123", + { + items: [ + { + id: "orli_123", + quantity: 1 + } + ] + }, + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx new file mode 100644 index 0000000000..a8389259e5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# addInboundShipping + +This method adds an inbound (or return) shipping method to a claim. +The inbound shipping method will have a `SHIPPING_ADD` action. + +This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinboundshippingmethod) +API route. + +## Example + +```ts +sdk.admin.claim.addInboundShipping( + "claim_123", + { + shipping_option_id: "so_123", + custom_amount: 10 + }, + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addItems/page.mdx new file mode 100644 index 0000000000..873337443c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addItems/page.mdx @@ -0,0 +1,30 @@ +import { TypeList } from "docs-ui" + +# addItems + +This method adds items to the claim. It sends a request to the +[Add Items](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidclaimitems) API route. + +## Example + +```ts +sdk.admin.claim.addItems("claim_123", { + items: [ + { + id: "orli_123", + quantity: 1 + } + ] +}) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundItems/page.mdx new file mode 100644 index 0000000000..0fb4aa1757 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundItems/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# addOutboundItems + +This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action. +It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutbounditems) +API route. + +## Example + +```ts +sdk.admin.claim.addOutboundItems( + "claim_123", + { + items: [{ + id: "orli_123", + quantity: 1 + }] + }, + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx new file mode 100644 index 0000000000..bf97c16b57 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx @@ -0,0 +1,33 @@ +import { TypeList } from "docs-ui" + +# addOutboundShipping + +This method adds outbound an outbound shipping method to a claim. +The outbound shipping method will have a `SHIPPING_ADD` action. + +This method sends a request to the +[Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutboundshippingmethod) +API route. + +## Example + +```ts +* sdk.admin.claim.addOutboundShipping( + "claim_123", + { + shipping_option_id: "so_123", + custom_amount: 10 + }, +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/page.mdx new file mode 100644 index 0000000000..1641b294ba --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/page.mdx @@ -0,0 +1,23 @@ +import { TypeList } from "docs-ui" + +# cancel + +This method cancels a claim. It sends a request to the +[Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidcancel) API route. + +## Example + +```ts +sdk.admin.claim.cancel("claim_123") +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx new file mode 100644 index 0000000000..46b142b87b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx @@ -0,0 +1,26 @@ +import { TypeList } from "docs-ui" + +# cancelRequest + +This method cancels a requested claim. It sends a request to the +[Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidrequest) +API route. + +## Example + +```ts +sdk.admin.claim.cancelRequest( + "claim_123", +) +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx new file mode 100644 index 0000000000..2629ae4abc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx @@ -0,0 +1,26 @@ +import { TypeList } from "docs-ui" + +# create + +This method creates a claim. It sends a request to the +[Create Claim](https://docs.medusajs.com/v2/api/admin#claims\_postclaims) API route. + +## Example + +```ts +sdk.admin.claim.create({ + type: "refund", + order_id: "order_123", +}) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim","type":"[AdminClaim](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[BaseClaimItem](../../../../../types/interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/page.mdx new file mode 100644 index 0000000000..8f70eb11d9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/page.mdx @@ -0,0 +1,30 @@ +import { TypeList } from "docs-ui" + +# deleteInboundShipping + +This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action. +It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidinboundshippingmethodaction\_id) +API route. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.deleteInboundShipping( + "claim_123", + "ordchact_123", + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/page.mdx new file mode 100644 index 0000000000..3c6ce884e1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/page.mdx @@ -0,0 +1,28 @@ +import { TypeList } from "docs-ui" + +# deleteOutboundShipping + +This method deletes the shipping method for delivering outbound items in the claim using the ID of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.deleteOutboundShipping( + "claim_123", + "ordchact_123", +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/page.mdx new file mode 100644 index 0000000000..0e1c1c2000 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/page.mdx @@ -0,0 +1,53 @@ +import { TypeList } from "docs-ui" + +# list + +This method retrieves a paginated list of claims. It sends a request to the +[List Claims](https://docs.medusajs.com/v2/api/admin#claims\_getclaims) API route. + +## Example + +To retrieve the list of claims: + +```ts +sdk.admin.claim.list() +.then(({ claims, count, limit, offset }) => { + console.log(claims) +}) +``` + +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.claim.list({ + limit: 10, + offset: 10 +}) +.then(({ claims, count, limit, offset }) => { + console.log(claims) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each claim: + +```ts +sdk.admin.claim.list({ + fields: "id,*additional_items" +}) +.then(({ claims, count, limit, offset }) => { + console.log(claims) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/page.mdx new file mode 100644 index 0000000000..e69eb9c73f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/page.mdx @@ -0,0 +1,30 @@ +import { TypeList } from "docs-ui" + +# removeInboundItem + +This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action. +It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidinbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.removeInboundItem( + "claim_123", + "ordchact_123", + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/page.mdx new file mode 100644 index 0000000000..3c49e1c4c1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/page.mdx @@ -0,0 +1,30 @@ +import { TypeList } from "docs-ui" + +# removeItem + +This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action. +It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidclaimitemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.removeItem( + "claim_123", + "ordchact_123", + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeItem"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/page.mdx new file mode 100644 index 0000000000..07c3af03e9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/page.mdx @@ -0,0 +1,30 @@ +import { TypeList } from "docs-ui" + +# removeOutboundItem + +This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action. +It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims\_deleteclaimsidoutbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.removeOutboundItem( + "claim_123", + "ordchact_123", +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.request/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.request/page.mdx new file mode 100644 index 0000000000..ee2b394f81 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.request/page.mdx @@ -0,0 +1,27 @@ +import { TypeList } from "docs-ui" + +# request + +This method confirms a claim request, applying its changes on the associated order. +It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidrequest) +API route. + +## Example + +```ts +sdk.admin.claim.request( + "claim_123", + {}, +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="request"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.retrieve/page.mdx new file mode 100644 index 0000000000..a439276312 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.retrieve/page.mdx @@ -0,0 +1,38 @@ +import { TypeList } from "docs-ui" + +# retrieve + +This method retrieves a claim. It sends a request to the +[Get Claim](https://docs.medusajs.com/v2/api/admin#claims\_getclaimsid) API route. + +## Example + +To retrieve a claim by its ID: + +```ts +sdk.admin.claim.retrieve("claim_123") +.then(({ claim }) => { + console.log(claim) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.claim.retrieve("claim_123", { + fields: "id,*additional_items" +}) +.then(({ claim }) => { + console.log(claim) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundItem/page.mdx new file mode 100644 index 0000000000..e9e2819ff8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundItem/page.mdx @@ -0,0 +1,33 @@ +import { TypeList } from "docs-ui" + +# updateInboundItem + +This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action. +It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.updateInboundItem( + "claim_123", + "ordchact_123", + { + quantity: 1 + }, + ) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/page.mdx new file mode 100644 index 0000000000..8c187e729f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/page.mdx @@ -0,0 +1,33 @@ +import { TypeList } from "docs-ui" + +# updateInboundShipping + +This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action. +It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidinboundshippingmethodaction\_id) +API route. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.updateInboundShipping( + "claim_123", + "ordchact_123", + { + custom_amount: 10 + }, + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx new file mode 100644 index 0000000000..99ad1ffb0a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# updateItem + +This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It +sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidclaimitemsaction\_id) API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.updateItem( + "claim_123", + "ordchact_123", + { + quantity: 1 + } + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateItem"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx new file mode 100644 index 0000000000..805be09761 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx @@ -0,0 +1,33 @@ +import { TypeList } from "docs-ui" + +# updateOutboundItem + +This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action. +It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutbounditemsaction\_id) +API route. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.updateOutboundItem( + "claim_123", + "ordchact_123", + { + quantity: 1 + }, + ) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/page.mdx new file mode 100644 index 0000000000..18c5afe162 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/page.mdx @@ -0,0 +1,33 @@ +import { TypeList } from "docs-ui" + +# updateOutboundShipping + +This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action. +It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims\_postclaimsidoutboundshippingmethodaction\_id) +API route. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +## Example + +```ts +sdk.admin.claim.updateOutboundShipping( + "claim_123", + "ordchact_123", + { + custom_amount: 10 + }, +) +.then(({ claim }) => { + console.log(claim) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the claim.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Claim/properties/js_sdk.admin.Claim.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Claim/properties/js_sdk.admin.Claim.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Claim/properties/js_sdk.admin.Claim.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/page.mdx new file mode 100644 index 0000000000..7d171db6d8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# clearToken + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken_/page.mdx new file mode 100644 index 0000000000..8d303a0932 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken_/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# clearToken\_ + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetch/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetch/page.mdx new file mode 100644 index 0000000000..71e48a11f5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetch/page.mdx @@ -0,0 +1,22 @@ +import { TypeList } from "docs-ui" + +# fetch + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetchStream/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetchStream/page.mdx new file mode 100644 index 0000000000..01bc75c795 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetchStream/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# fetchStream + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getApiKeyHeader_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getApiKeyHeader_/page.mdx new file mode 100644 index 0000000000..1dd19d8f0e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getApiKeyHeader_/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# getApiKeyHeader\_ + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getJwtHeader_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getJwtHeader_/page.mdx new file mode 100644 index 0000000000..039c2088a1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getJwtHeader_/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# getJwtHeader\_ + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/page.mdx new file mode 100644 index 0000000000..261ce37a61 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# getPublishableKeyHeader\_ + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getTokenStorageInfo_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getTokenStorageInfo_/page.mdx new file mode 100644 index 0000000000..954c3c8b35 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getTokenStorageInfo_/page.mdx @@ -0,0 +1,9 @@ +import { TypeList } from "docs-ui" + +# getTokenStorageInfo\_ + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken_/page.mdx new file mode 100644 index 0000000000..8f92377850 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken_/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# getToken\_ + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.initClient/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.initClient/page.mdx new file mode 100644 index 0000000000..bb61602c88 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.initClient/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# initClient + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken/page.mdx new file mode 100644 index 0000000000..ce9d067a55 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# setToken + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken_/page.mdx new file mode 100644 index 0000000000..da1cd9c791 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken_/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# setToken\_ + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.DEFAULT_JWT_STORAGE_KEY/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.DEFAULT_JWT_STORAGE_KEY/page.mdx new file mode 100644 index 0000000000..6556b3fd9f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.DEFAULT_JWT_STORAGE_KEY/page.mdx @@ -0,0 +1,3 @@ +import { TypeList } from "docs-ui" + +# DEFAULT\_JWT\_STORAGE\_KEY diff --git a/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.config/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.config/page.mdx new file mode 100644 index 0000000000..87546cecdf --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.config/page.mdx @@ -0,0 +1,87 @@ +import { TypeList } from "docs-ui" + +# config + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug diff --git a/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.fetch_/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.fetch_/page.mdx new file mode 100644 index 0000000000..5c9ec8dee1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.fetch_/page.mdx @@ -0,0 +1,3 @@ +import { TypeList } from "docs-ui" + +# fetch\_ diff --git a/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.logger/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.logger/page.mdx new file mode 100644 index 0000000000..425c56ea22 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.logger/page.mdx @@ -0,0 +1,49 @@ +import { TypeList } from "docs-ui" + +# logger + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.token/page.mdx b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.token/page.mdx new file mode 100644 index 0000000000..9c905782de --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Client/properties/js_sdk.admin.Client.token/page.mdx @@ -0,0 +1,3 @@ +import { TypeList } from "docs-ui" + +# token diff --git a/www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/page.mdx new file mode 100644 index 0000000000..d66f07d8b4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/page.mdx @@ -0,0 +1,54 @@ +import { TypeList } from "docs-ui" + +# list + +This method retrieves a paginated list of currencies. It sends a request to the +[List Currencies](https://docs.medusajs.com/v2/api/admin#currencies\_getcurrencies) +API route. + +## Example + +To retrieve the list of currencies: + +```ts +sdk.admin.currency.list() +.then(({ currencies, count, limit, offset }) => { + console.log(currencies) +}) +``` + +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.currency.list({ + limit: 10, + offset: 10 +}) +.then(({ currencies, count, limit, offset }) => { + console.log(currencies) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each currency: + +```ts +sdk.admin.currency.list({ + fields: "code,symbol" +}) +.then(({ currencies, count, limit, offset }) => { + console.log(currencies) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/page.mdx new file mode 100644 index 0000000000..bad976d327 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/page.mdx @@ -0,0 +1,38 @@ +import { TypeList } from "docs-ui" + +# retrieve + +This method retrieves a currency by its code. It sends a request to the +[Get Currency](https://docs.medusajs.com/v2/api/admin#currencies\_getcurrenciescode) API route. + +## Example + +To retrieve a currency by its code: + +```ts +sdk.admin.currency.retrieve("usd") +.then(({ currency }) => { + console.log(currency) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.currency.retrieve("usd", { + fields: "code,symbol" +}) +.then(({ currency }) => { + console.log(currency) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Currency/properties/js_sdk.admin.Currency.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Currency/properties/js_sdk.admin.Currency.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Currency/properties/js_sdk.admin.Currency.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/page.mdx new file mode 100644 index 0000000000..43ed9d6cad --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# create + +This method creates a customer. It sends a request to the +[Create Customer](https://docs.medusajs.com/v2/api/admin#customers\_postcustomers) API route. + +## Example + +```ts +sdk.admin.customer.create({ + email: "customer@gmail.com" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/page.mdx new file mode 100644 index 0000000000..ed9efcaef3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/page.mdx @@ -0,0 +1,24 @@ +import { TypeList } from "docs-ui" + +# delete + +This method deletes a customer by its ID. It sends a request to the +[Delete Customer](https://docs.medusajs.com/v2/api/admin#customers\_deletecustomersid) +API route. + +## Example + +```ts +sdk.admin.customer.delete("cus_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/page.mdx new file mode 100644 index 0000000000..5c370df8d9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/page.mdx @@ -0,0 +1,54 @@ +import { TypeList } from "docs-ui" + +# list + +This method retrieves a paginated list of customers. It sends a request to the +[List Customers](https://docs.medusajs.com/v2/api/admin#customers\_getcustomers) +API route. + +## Example + +To retrieve the list of customers: + +```ts +sdk.admin.customer.list() +.then(({ customers, count, limit, offset }) => { + console.log(customers) +}) +``` + +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.customer.list({ + limit: 10, + offset: 10 +}) +.then(({ customers, count, limit, offset }) => { + console.log(customers) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each customer: + +```ts +sdk.admin.customer.list({ + fields: "id,*groups" +}) +.then(({ customers, count, limit, offset }) => { + console.log(customers) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/page.mdx new file mode 100644 index 0000000000..32f8418b4f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/page.mdx @@ -0,0 +1,39 @@ +import { TypeList } from "docs-ui" + +# retrieve + +This method retrieves a customer by its ID. It sends a request to the +[Get Customer](https://docs.medusajs.com/v2/api/admin#customers\_getcustomersid) +API route. + +## Example + +To retrieve a customer by its ID: + +```ts +sdk.admin.customer.retrieve("cus_123") +.then(({ customer }) => { + console.log(customer) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.customer.retrieve("cus_123", { + fields: "id,*groups" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/page.mdx new file mode 100644 index 0000000000..0946a96c1a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# update + +This method updates a customer's details. It sends a request to the +[Update Customer](https://docs.medusajs.com/v2/api/admin#customers\_postcustomersid) API route. + +## Example + +```ts +sdk.admin.customer.update("cus_123", { + first_name: "John" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Customer/properties/js_sdk.admin.Customer.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Customer/properties/js_sdk.admin.Customer.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Customer/properties/js_sdk.admin.Customer.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/page.mdx new file mode 100644 index 0000000000..42522c3029 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/page.mdx @@ -0,0 +1,27 @@ +import { TypeList } from "docs-ui" + +# batchCustomers + +This method manages customers of a group to add or remove them from the group. +It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups\_postcustomergroupsidcustomers) +API route. + +## Example + +```ts +sdk.admin.customerGroup.batchCustomers("cusgroup_123", { + add: ["cus_123"], + remove: ["cus_321"] +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchCustomers"/> diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/page.mdx new file mode 100644 index 0000000000..b81a60c13e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/page.mdx @@ -0,0 +1,26 @@ +import { TypeList } from "docs-ui" + +# create + +This method creates a customer group. It sends a request to the +[Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups\_postcustomergroups) +API route. + +## Example + +```ts +sdk.admin.customerGroup.create({ + name: "VIP" +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetCustomerGroupParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupParams/page.mdx)","description":"Configure the fields to retrieve in the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/page.mdx new file mode 100644 index 0000000000..ecda75b797 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/page.mdx @@ -0,0 +1,24 @@ +import { TypeList } from "docs-ui" + +# delete + +This method deletes a customer group. This method sends a request to the +[Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups\_deletecustomergroupsid) +API route. + +## Example + +```ts +sdk.admin.customerGroup.delete("cusgroup_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx new file mode 100644 index 0000000000..bfc372016f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx @@ -0,0 +1,54 @@ +import { TypeList } from "docs-ui" + +# list + +This method retrieves a paginated list of customer groups. It sends a request to the +[List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups\_getcustomergroups) +API route. + +## Example + +To retrieve the list of customer groups: + +```ts +sdk.admin.customerGroup.list() +.then(({ customer_groups, count, limit, offset }) => { + console.log(customer_groups) +}) +``` + +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.customerGroup.list({ + limit: 10, + offset: 10 +}) +.then(({ customer_groups, count, limit, offset }) => { + console.log(customer_groups) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each customer group: + +```ts +sdk.admin.customerGroup.list({ + fields: "id,*customer" +}) +.then(({ customer_groups, count, limit, offset }) => { + console.log(customer_groups) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/page.mdx new file mode 100644 index 0000000000..5d5bebc88a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/page.mdx @@ -0,0 +1,38 @@ +import { TypeList } from "docs-ui" + +# retrieve + +This method retrieves a customer group by its ID. It sends a request to the +[Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups\_getcustomergroupsid) API route. + +## Example + +To retrieve a customer group by its ID: + +```ts +sdk.admin.customerGroup.retrieve("cusgroup_123") +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.customerGroup.retrieve("cusgroup_123", { + fields: "id,*customer" +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/page.mdx new file mode 100644 index 0000000000..19c642aadd --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/page.mdx @@ -0,0 +1,26 @@ +import { TypeList } from "docs-ui" + +# update + +This method updates a customer group's details. It sends a request to the +[Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups\_postcustomergroupsid) +API route. + +## Example + +```ts +sdk.admin.customerGroup.update("cusgroup_123", { + name: "VIP" +}) +.then(({ customer_group }) => { + console.log(customer_group) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetCustomerGroupParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetCustomerGroupParams/page.mdx)","description":"Configure the fields to retrieve in the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/CustomerGroup/properties/js_sdk.admin.CustomerGroup.client/page.mdx b/www/apps/resources/references/js_sdk/admin/CustomerGroup/properties/js_sdk.admin.CustomerGroup.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/CustomerGroup/properties/js_sdk.admin.CustomerGroup.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx new file mode 100644 index 0000000000..e129479535 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx @@ -0,0 +1,31 @@ +import { TypeList } from "docs-ui" + +# addInboundItems + +This method adds inbound (or return) items to an exchange. These inbound items will +have the action `RETURN_ITEM`. + +This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinbounditems) +API route. + +## Example + +```ts +sdk.admin.exchange.addInboundItems("exchange_123", { + items: [{ + id: "orli_123", + quantity: 1 + }] +}) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/page.mdx new file mode 100644 index 0000000000..762e040f0a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/page.mdx @@ -0,0 +1,31 @@ +import { TypeList } from "docs-ui" + +# addInboundShipping + +This method adds an inbound (or return) shipping method to an exchange. +The inbound shipping method will have a `SHIPPING_ADD` action. + +This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinboundshippingmethod) +API route. + +This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinboundshippingmethod) +API route. + +## Example + +```ts +sdk.admin.exchange.addInboundShipping("exchange_123", { + shipping_option_id: "so_123" +}) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addInboundShipping"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx new file mode 100644 index 0000000000..b3ee444c54 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx @@ -0,0 +1,31 @@ +import { TypeList } from "docs-ui" + +# addOutboundItems + +This method adds outbound (or new) items to an exchange. +These outbound items will have the action `ITEM_ADD`. + +This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutbounditems) +API route. + +## Example + +```ts +sdk.admin.exchange.addOutboundItems("exchange_123", { + items: [{ + id: "variant_123", + quantity: 1 + }] +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundItems"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/page.mdx new file mode 100644 index 0000000000..8828de11a6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/page.mdx @@ -0,0 +1,28 @@ +import { TypeList } from "docs-ui" + +# addOutboundShipping + +This method adds an outbound shipping method to an exchange. The outbound shipping method +will have a `SHIPPING_ADD` action. + +This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutboundshippingmethod) +API route. + +## Example + +```ts +sdk.admin.exchange.addOutboundShipping("exchange_123", { + shipping_option_id: "so_123" +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addOutboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/page.mdx new file mode 100644 index 0000000000..97f7bdbde2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/page.mdx @@ -0,0 +1,23 @@ +import { TypeList } from "docs-ui" + +# cancel + +This method cancels an exchange. It sends a request to the +[Cancel Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidcancel) API route. + +## Example + +```ts +sdk.admin.exchange.cancel("exchange_123") +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancel"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancelRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancelRequest/page.mdx new file mode 100644 index 0000000000..c1a5328c80 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancelRequest/page.mdx @@ -0,0 +1,24 @@ +import { TypeList } from "docs-ui" + +# cancelRequest + +This method cancels an exchange request. It sends a request to the +[Cancel Exchange Request](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidrequest) +API route. + +## Example + +```ts +sdk.admin.exchange.cancel("exchange_123") +.then(({ deleted }) => { + console.log(deleted) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.create/page.mdx new file mode 100644 index 0000000000..ccb63057f6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.create/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# create + +This method creates an admin exchange. It sends a request to the +[Create Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchanges) API route. + +## Example + +```ts +sdk.admin.exchange.create({ + order_id: "order_123" +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/page.mdx new file mode 100644 index 0000000000..83c007388e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# deleteInboundShipping + +This method removes the shipping method for returning items in the exchange using the ID +of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidinboundshippingmethodaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.deleteInboundShipping( + "exchange_123", + "ordchact_123", +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/page.mdx new file mode 100644 index 0000000000..db45fc4ba2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# deleteOutboundShipping + +This method removes the shipping method for delivering outbound items in the exchange using +the ID of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidoutboundshippingmethodaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.deleteOutboundShipping( + "exchange_123", + "ordchact_123", +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteOutboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/page.mdx new file mode 100644 index 0000000000..fa753d21ab --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/page.mdx @@ -0,0 +1,54 @@ +import { TypeList } from "docs-ui" + +# list + +This method retrieves a paginated list of exchanges. It sends a request to the +[List Exchanges](https://docs.medusajs.com/v2/api/admin#exchanges\_getexchanges) +API route. + +## Example + +To retrieve the list of exchanges: + +```ts +sdk.admin.exchange.list() +.then(({ exchanges, count, limit, offset }) => { + console.log(exchanges) +}) +``` + +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.exchange.list({ + limit: 10, + offset: 10 +}) +.then(({ exchanges, count, limit, offset }) => { + console.log(exchanges) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each exchange: + +```ts +sdk.admin.exchange.list({ + fields: "id,*order" +}) +.then(({ exchanges, count, limit, offset }) => { + console.log(exchanges) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/page.mdx new file mode 100644 index 0000000000..4657e754f7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# removeInboundItem + +This method removes an inbound (or return) item from an exchange using the ID of the +item's `RETURN_ITEM` action. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidinbounditemsaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.removeInboundItem( + "exchange_123", + "ordchact_123", +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/page.mdx new file mode 100644 index 0000000000..e6f0278f74 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# removeOutboundItem + +This method removes an outbound (or new) item from an exchange using the ID +of the item's `ITEM_ADD` action. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_deleteexchangesidoutbounditemsaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.removeOutboundItem( + "exchange_123", + "ordchact_123", +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="removeOutboundItem"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.request/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.request/page.mdx new file mode 100644 index 0000000000..ed6d41269e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.request/page.mdx @@ -0,0 +1,25 @@ +import { TypeList } from "docs-ui" + +# request + +This method confirms an exchange request, applying its changes on the associated order. + +This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidrequest) +API route. + +## Example + +```ts +sdk.admin.exchange.request("exchange_123", {}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="request"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/page.mdx new file mode 100644 index 0000000000..d213c39aa6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/page.mdx @@ -0,0 +1,39 @@ +import { TypeList } from "docs-ui" + +# retrieve + +This method retrieves an exchange by its ID. It sends a request to the +[Get Exchange](https://docs.medusajs.com/v2/api/admin#exchanges\_getexchangesid) +API route. + +## Example + +To retrieve an exchange by its ID: + +```ts +sdk.admin.exchange.retrieve("exchange_123") +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.admin.exchange.retrieve("exchange_123", { + fields: "id,*order" +}) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/page.mdx new file mode 100644 index 0000000000..9ee293e80e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/page.mdx @@ -0,0 +1,35 @@ +import { TypeList } from "docs-ui" + +# updateInboundItem + +This method updates an inbound (or return) item from an exchange using the ID of +the item's `RETURN_ITEM` action. + +Every item has an `actions` property, whose value is an array of actions. You can +check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinbounditemsaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.updateInboundItem( + "exchange_123", + "ordchact_123", + { + quantity: 1 + } +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/page.mdx new file mode 100644 index 0000000000..e6016249fa --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/page.mdx @@ -0,0 +1,35 @@ +import { TypeList } from "docs-ui" + +# updateInboundShipping + +This method updates the shipping method for returning items in the exchange using the ID +of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidinboundshippingmethodaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.updateInboundShipping( + "exchange_123", + "ordchact_123", + { + custom_amount: 10 + } +) +.then(({ return: returnData }) => { + console.log(returnData) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateInboundShipping"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx new file mode 100644 index 0000000000..9729f98aa4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx @@ -0,0 +1,35 @@ +import { TypeList } from "docs-ui" + +# updateOutboundItem + +This method updates an outbound (or new) item from an exchange using the ID +of the item's `ITEM_ADD` action. + +Every item has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutbounditemsaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.updateOutboundItem( + "exchange_123", + "ordchact_123", + { + quantity: 1 + } +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundItem"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/page.mdx new file mode 100644 index 0000000000..4aa9e63674 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/page.mdx @@ -0,0 +1,35 @@ +import { TypeList } from "docs-ui" + +# updateOutboundShipping + +This method updates the shipping method for delivering outbound items in the exchange using +the ID of the method's `SHIPPING_ADD` action. + +Every shipping method has an `actions` property, whose value is an array of actions. +You can check the action's name using its `action` property, and use the value of the `id` property. + +This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges\_postexchangesidoutboundshippingmethodaction\_id) +API route. + +## Example + +```ts +sdk.admin.exchange.updateOutboundShipping( + "exchange_123", + "ordchact_123", + { + custom_amount: 10 + } +) +.then(({ exchange }) => { + console.log(exchange) +}) +``` + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the exchange.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateOutboundShipping"/> diff --git a/www/apps/resources/references/js_sdk/admin/Exchange/properties/js_sdk.admin.Exchange.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Exchange/properties/js_sdk.admin.Exchange.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Exchange/properties/js_sdk.admin.Exchange.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.abort/page.mdx b/www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.abort/page.mdx new file mode 100644 index 0000000000..212fd1f1f8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.abort/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# abort + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.stream/page.mdx b/www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.stream/page.mdx new file mode 100644 index 0000000000..cd8ca8c8d6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.stream/page.mdx @@ -0,0 +1,13 @@ +import { TypeList } from "docs-ui" + +# stream + +Ignored by the client. + +A string identifying the type of event described. + +The data field for the message. Split by new lines. + +The event ID to set the EventSource object's last event ID value. + +The reconnection time. diff --git a/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/page.mdx b/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/page.mdx new file mode 100644 index 0000000000..8ca01b5511 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancel + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/page.mdx new file mode 100644 index 0000000000..3ecd9ca709 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/page.mdx b/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/page.mdx new file mode 100644 index 0000000000..5058c10927 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createShipment + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Fulfillment/properties/js_sdk.admin.Fulfillment.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Fulfillment/properties/js_sdk.admin.Fulfillment.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Fulfillment/properties/js_sdk.admin.Fulfillment.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx new file mode 100644 index 0000000000..e00349f778 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx @@ -0,0 +1,54 @@ +import { TypeList } from "docs-ui" + +# list + +This method retrieves a paginated list of fulfillment providers. It sends a request to the +[List Fulfillment Providers](https://docs.medusajs.com/v2/api/admin#fulfillment-providers\_getfulfillmentproviders) +API route. + +## Example + +To retrieve the list of fulfillment providers: + +```ts +sdk.admin.fulfillmentProvider.list() +.then(({ fulfillment_providers, count, limit, offset }) => { + console.log(fulfillment_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.fulfillmentProvider.list({ + limit: 10, + offset: 10 +}) +.then(({ fulfillment_providers, count, limit, offset }) => { + console.log(fulfillment_providers) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each fulfillment provider: + +```ts +sdk.admin.fulfillmentProvider.list({ + fields: "id" +}) +.then(({ fulfillment_providers, count, limit, offset }) => { + console.log(fulfillment_providers) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentProvider/properties/js_sdk.admin.FulfillmentProvider.client/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentProvider/properties/js_sdk.admin.FulfillmentProvider.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentProvider/properties/js_sdk.admin.FulfillmentProvider.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/page.mdx new file mode 100644 index 0000000000..6a8f3b43e5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createServiceZone + +## Parameters + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createServiceZone"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/page.mdx new file mode 100644 index 0000000000..a1b50e6bbf --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/page.mdx new file mode 100644 index 0000000000..a226ddcfb2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# deleteServiceZone + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.retrieveServiceZone/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.retrieveServiceZone/page.mdx new file mode 100644 index 0000000000..3b2c3aad2c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.retrieveServiceZone/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieveServiceZone + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.updateServiceZone/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.updateServiceZone/page.mdx new file mode 100644 index 0000000000..67f7382bb4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.updateServiceZone/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateServiceZone + +## Parameters + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateServiceZone"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/FulfillmentSet/properties/js_sdk.admin.FulfillmentSet.client/page.mdx b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/properties/js_sdk.admin.FulfillmentSet.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/FulfillmentSet/properties/js_sdk.admin.FulfillmentSet.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/page.mdx new file mode 100644 index 0000000000..ea9df8a616 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# batchUpdateLevels + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchUpdateLevels"/> diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx new file mode 100644 index 0000000000..f84ee6f9d5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx new file mode 100644 index 0000000000..6fd56da044 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/page.mdx new file mode 100644 index 0000000000..d13f0a3652 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# deleteLevel + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx new file mode 100644 index 0000000000..0a7965a44b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[AdminInventoryItemParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryItemParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"`Record<\"location_id\", string \\| string[]>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"length","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"height","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"width","type":"`number` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<number>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location_levels","type":"`Record<\"location_id\", string \\| string[]>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx new file mode 100644 index 0000000000..36d00e4fd5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listLevels + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/page.mdx new file mode 100644 index 0000000000..fec5c8a439 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx new file mode 100644 index 0000000000..f98de0ba9c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx new file mode 100644 index 0000000000..ceb5a1cabd --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateLevel + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_levels","type":"[AdminInventoryLevel](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminInventoryLevel/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateLevel"/> diff --git a/www/apps/resources/references/js_sdk/admin/InventoryItem/properties/js_sdk.admin.InventoryItem.client/page.mdx b/www/apps/resources/references/js_sdk/admin/InventoryItem/properties/js_sdk.admin.InventoryItem.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/InventoryItem/properties/js_sdk.admin.InventoryItem.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx new file mode 100644 index 0000000000..b9fcd2d900 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# accept + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/page.mdx new file mode 100644 index 0000000000..df8668d9e6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/page.mdx new file mode 100644 index 0000000000..8b54f6ec65 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx new file mode 100644 index 0000000000..0b7bd515e4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.resend/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.resend/page.mdx new file mode 100644 index 0000000000..0347b9f083 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.resend/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# resend + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.retrieve/page.mdx new file mode 100644 index 0000000000..9edd077e0b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Invite/properties/js_sdk.admin.Invite.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Invite/properties/js_sdk.admin.Invite.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Invite/properties/js_sdk.admin.Invite.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx new file mode 100644 index 0000000000..6398fbaa89 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx new file mode 100644 index 0000000000..680b85c8f1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"trigger_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receiver_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_notification_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/Notification/properties/js_sdk.admin.Notification.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Notification/properties/js_sdk.admin.Notification.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Notification/properties/js_sdk.admin.Notification.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/page.mdx new file mode 100644 index 0000000000..9acc3ea03c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancel + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx new file mode 100644 index 0000000000..c3279e9243 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancelFulfillment + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx new file mode 100644 index 0000000000..e036008c2c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createFulfillment + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/page.mdx new file mode 100644 index 0000000000..590748ca8d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createShipment + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/page.mdx new file mode 100644 index 0000000000..fb32de5b8f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/page.mdx new file mode 100644 index 0000000000..9f8ddb65b8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listChanges + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/page.mdx new file mode 100644 index 0000000000..768290be72 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listLineItems + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/page.mdx new file mode 100644 index 0000000000..66fbeba465 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# markAsDelivered + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/page.mdx new file mode 100644 index 0000000000..b59168b963 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx new file mode 100644 index 0000000000..c46e20d96e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrievePreview + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Order/properties/js_sdk.admin.Order.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/page.mdx new file mode 100644 index 0000000000..243cb1392a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# addItems + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addItems"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/page.mdx new file mode 100644 index 0000000000..71ddc4ce6a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancelRequest + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/page.mdx new file mode 100644 index 0000000000..ec72c0ac78 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# confirm + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.initiateRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.initiateRequest/page.mdx new file mode 100644 index 0000000000..fc8c0a38df --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.initiateRequest/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# initiateRequest + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initiateRequest"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.removeAddedItem/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.removeAddedItem/page.mdx new file mode 100644 index 0000000000..9de4668154 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.removeAddedItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# removeAddedItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.request/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.request/page.mdx new file mode 100644 index 0000000000..eb7fc24908 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.request/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# request + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateAddedItem/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateAddedItem/page.mdx new file mode 100644 index 0000000000..ac6b77e7a4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateAddedItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateAddedItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/page.mdx new file mode 100644 index 0000000000..8461fc498b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateOriginalItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/OrderEdit/properties/js_sdk.admin.OrderEdit.client/page.mdx b/www/apps/resources/references/js_sdk/admin/OrderEdit/properties/js_sdk.admin.OrderEdit.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/OrderEdit/properties/js_sdk.admin.OrderEdit.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/page.mdx b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/page.mdx new file mode 100644 index 0000000000..bbc8dba442 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# capture + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/page.mdx new file mode 100644 index 0000000000..556be99cbc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx new file mode 100644 index 0000000000..5764580122 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listPaymentProviders + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/page.mdx b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/page.mdx new file mode 100644 index 0000000000..bbb843d6de --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# refund + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/page.mdx new file mode 100644 index 0000000000..4837deb509 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Payment/properties/js_sdk.admin.Payment.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Payment/properties/js_sdk.admin.Payment.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Payment/properties/js_sdk.admin.Payment.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx new file mode 100644 index 0000000000..6b2e4250dc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/page.mdx new file mode 100644 index 0000000000..e0808408de --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.list/page.mdx b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.list/page.mdx new file mode 100644 index 0000000000..d78decd4ac --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/page.mdx b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/page.mdx new file mode 100644 index 0000000000..0676928e3b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# markAsPaid + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.retrieve/page.mdx new file mode 100644 index 0000000000..b1daf0a904 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PaymentCollection/properties/js_sdk.admin.PaymentCollection.client/page.mdx b/www/apps/resources/references/js_sdk/admin/PaymentCollection/properties/js_sdk.admin.PaymentCollection.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PaymentCollection/properties/js_sdk.admin.PaymentCollection.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/page.mdx new file mode 100644 index 0000000000..0a52abf9a8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# batchPrices + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[AdminUpdatePriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdatePriceListPrice/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delete","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminPriceListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPrices"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchPrices"/> diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/page.mdx new file mode 100644 index 0000000000..94884c3c24 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminCreatePriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreatePriceListPrice/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[AdminPriceListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/page.mdx new file mode 100644 index 0000000000..87736ef665 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/page.mdx new file mode 100644 index 0000000000..902d49aa76 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# linkProducts + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkProducts"/> diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/page.mdx new file mode 100644 index 0000000000..7f98cf63b4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/page.mdx new file mode 100644 index 0000000000..defd6cf131 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/page.mdx new file mode 100644 index 0000000000..b1ff694ed2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminPriceListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../../../../pricing/types/pricing.PriceListStatus/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../../../../pricing/types/pricing.PriceListType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[AdminPriceListPrice](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPriceListPrice/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/PriceList/properties/js_sdk.admin.PriceList.client/page.mdx b/www/apps/resources/references/js_sdk/admin/PriceList/properties/js_sdk.admin.PriceList.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PriceList/properties/js_sdk.admin.PriceList.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/page.mdx b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/page.mdx new file mode 100644 index 0000000000..0c854c4964 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/page.mdx new file mode 100644 index 0000000000..1fd24d2f0b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx new file mode 100644 index 0000000000..69f706a2c5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/page.mdx new file mode 100644 index 0000000000..06258bae88 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/page.mdx b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/page.mdx new file mode 100644 index 0000000000..81668e9397 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/PricePreference/properties/js_sdk.admin.PricePreference.client/page.mdx b/www/apps/resources/references/js_sdk/admin/PricePreference/properties/js_sdk.admin.PricePreference.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/PricePreference/properties/js_sdk.admin.PricePreference.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/page.mdx new file mode 100644 index 0000000000..1d70d53121 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# batch + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx new file mode 100644 index 0000000000..a39e4f3299 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# batchVariantInventoryItems + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/page.mdx new file mode 100644 index 0000000000..f9ed933ba3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# batchVariants + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/page.mdx new file mode 100644 index 0000000000..a60bd1cdfa --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# confirmImport + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/page.mdx new file mode 100644 index 0000000000..48591e134f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/page.mdx new file mode 100644 index 0000000000..64885d6f12 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createOption + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/page.mdx new file mode 100644 index 0000000000..870a286187 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createVariant + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/page.mdx new file mode 100644 index 0000000000..e6466d5ce3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/page.mdx new file mode 100644 index 0000000000..5fe68718da --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# deleteOption + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/page.mdx new file mode 100644 index 0000000000..bc4371c3bf --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# deleteVariant + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/page.mdx new file mode 100644 index 0000000000..ff1f71c3f4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# export + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/page.mdx new file mode 100644 index 0000000000..e4528ae396 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# import + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx new file mode 100644 index 0000000000..1fc433f694 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/page.mdx new file mode 100644 index 0000000000..88c4e0b1ae --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listOptions + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/page.mdx new file mode 100644 index 0000000000..ce5872e532 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listVariants + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/page.mdx new file mode 100644 index 0000000000..ad6489d08f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/page.mdx new file mode 100644 index 0000000000..daee9dcc67 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieveOption + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx new file mode 100644 index 0000000000..b864a55fd2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieveVariant + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/page.mdx new file mode 100644 index 0000000000..e653727a02 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/page.mdx new file mode 100644 index 0000000000..7b8fcc9908 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateOption + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/page.mdx new file mode 100644 index 0000000000..729fe43f9d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateVariant + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Product/properties/js_sdk.admin.Product.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/properties/js_sdk.admin.Product.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Product/properties/js_sdk.admin.Product.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/page.mdx new file mode 100644 index 0000000000..b8c2c74061 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductCategoryParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/page.mdx new file mode 100644 index 0000000000..d7e0146688 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx new file mode 100644 index 0000000000..eb843a803b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/page.mdx new file mode 100644 index 0000000000..d5053ccf1c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/page.mdx new file mode 100644 index 0000000000..149d7df168 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductCategoryParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductCategoryParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_ancestors_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_descendants_tree","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/page.mdx new file mode 100644 index 0000000000..6a84f0b6ec --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateProducts + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProducts"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCategory/properties/js_sdk.admin.ProductCategory.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCategory/properties/js_sdk.admin.ProductCategory.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCategory/properties/js_sdk.admin.ProductCategory.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/page.mdx new file mode 100644 index 0000000000..a191df987d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminCollectionParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/page.mdx new file mode 100644 index 0000000000..1ac92fcce9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx new file mode 100644 index 0000000000..028730ed18 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/page.mdx new file mode 100644 index 0000000000..ffabd85560 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/page.mdx new file mode 100644 index 0000000000..5c227a93a3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminCollectionParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/page.mdx new file mode 100644 index 0000000000..101cc7cfa2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateProducts + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`AdminProduct`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProducts"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/properties/js_sdk.admin.ProductCollection.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/properties/js_sdk.admin.ProductCollection.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/properties/js_sdk.admin.ProductCollection.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.create/page.mdx new file mode 100644 index 0000000000..74ae23645a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductTagParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.delete/page.mdx new file mode 100644 index 0000000000..2eeb226d6b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx new file mode 100644 index 0000000000..c0d41aff64 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/page.mdx new file mode 100644 index 0000000000..37ac7bd01c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.update/page.mdx new file mode 100644 index 0000000000..1f7512867f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminProductTagParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductTagParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductTag/properties/js_sdk.admin.ProductTag.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductTag/properties/js_sdk.admin.ProductTag.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductTag/properties/js_sdk.admin.ProductTag.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/page.mdx new file mode 100644 index 0000000000..d3083ddf15 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/page.mdx new file mode 100644 index 0000000000..ef80a8918b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/page.mdx new file mode 100644 index 0000000000..803d7b382d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/page.mdx new file mode 100644 index 0000000000..b02e204640 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/page.mdx new file mode 100644 index 0000000000..1d472a601a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ProductType/properties/js_sdk.admin.ProductType.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductType/properties/js_sdk.admin.ProductType.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductType/properties/js_sdk.admin.ProductType.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx new file mode 100644 index 0000000000..f864877f13 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ProductVariant/properties/js_sdk.admin.ProductVariant.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductVariant/properties/js_sdk.admin.ProductVariant.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ProductVariant/properties/js_sdk.admin.ProductVariant.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx new file mode 100644 index 0000000000..067cc8be73 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# addRules + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx new file mode 100644 index 0000000000..af6ac050e1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx new file mode 100644 index 0000000000..9b9d461ac7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx new file mode 100644 index 0000000000..4aadf41109 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx new file mode 100644 index 0000000000..48c961e599 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listRuleAttributes + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx new file mode 100644 index 0000000000..7b72f9f728 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listRuleValues + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx new file mode 100644 index 0000000000..aa4e97c5d9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# listRules + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx new file mode 100644 index 0000000000..90272788ae --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# removeRules + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx new file mode 100644 index 0000000000..89de140430 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx new file mode 100644 index 0000000000..6e95ff0230 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx new file mode 100644 index 0000000000..cdcc2f0f86 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateRules + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Promotion/properties/js_sdk.admin.Promotion.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Promotion/properties/js_sdk.admin.Promotion.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Promotion/properties/js_sdk.admin.Promotion.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx b/www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx new file mode 100644 index 0000000000..c4f499637b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/RefundReason/properties/js_sdk.admin.RefundReason.client/page.mdx b/www/apps/resources/references/js_sdk/admin/RefundReason/properties/js_sdk.admin.RefundReason.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/RefundReason/properties/js_sdk.admin.RefundReason.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.create/page.mdx new file mode 100644 index 0000000000..e0209c6d1a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/page.mdx new file mode 100644 index 0000000000..c43573f6f3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/page.mdx new file mode 100644 index 0000000000..bc22a806a1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.retrieve/page.mdx new file mode 100644 index 0000000000..56a77652ef --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.update/page.mdx new file mode 100644 index 0000000000..c370d718df --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Region/properties/js_sdk.admin.Region.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Region/properties/js_sdk.admin.Region.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Region/properties/js_sdk.admin.Region.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/page.mdx new file mode 100644 index 0000000000..192cd95fad --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetReservationsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetReservationsParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.delete/page.mdx new file mode 100644 index 0000000000..367045622a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/page.mdx new file mode 100644 index 0000000000..c532bafb07 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.retrieve/page.mdx new file mode 100644 index 0000000000..3696e22cdb --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/page.mdx new file mode 100644 index 0000000000..3e1e0d904d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminGetReservationsParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminGetReservationsParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/Reservation/properties/js_sdk.admin.Reservation.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Reservation/properties/js_sdk.admin.Reservation.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Reservation/properties/js_sdk.admin.Reservation.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnItem/page.mdx new file mode 100644 index 0000000000..6bf9b1a2c7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# addReturnItem + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addReturnItem"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/page.mdx new file mode 100644 index 0000000000..8f4ed0b720 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# addReturnShipping + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addReturnShipping"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancel/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancel/page.mdx new file mode 100644 index 0000000000..5efe0c79a3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancel/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancel + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelReceive/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelReceive/page.mdx new file mode 100644 index 0000000000..8b483c6413 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelReceive/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancelReceive + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelRequest/page.mdx new file mode 100644 index 0000000000..1466413ef7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelRequest/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# cancelRequest + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmReceive/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmReceive/page.mdx new file mode 100644 index 0000000000..ff4eabc03f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmReceive/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# confirmReceive + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmRequest/page.mdx new file mode 100644 index 0000000000..3aef54d13b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmRequest/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# confirmRequest + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/page.mdx new file mode 100644 index 0000000000..c7e74225bc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# deleteReturnShipping + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.dismissItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.dismissItems/page.mdx new file mode 100644 index 0000000000..5126e9fad8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.dismissItems/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# dismissItems + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateReceive/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateReceive/page.mdx new file mode 100644 index 0000000000..48173089d7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateReceive/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# initiateReceive + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initiateReceive"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/page.mdx new file mode 100644 index 0000000000..312b36bc37 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# initiateRequest + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initiateRequest"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/page.mdx new file mode 100644 index 0000000000..51f502f7cd --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + +` \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<Record<string, unknown>>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../types/types/types.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../types/types/types.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/page.mdx new file mode 100644 index 0000000000..ef69d372d3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# receiveItems + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/page.mdx new file mode 100644 index 0000000000..d663b3ff6e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# removeDismissItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReceiveItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReceiveItem/page.mdx new file mode 100644 index 0000000000..49c679edda --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReceiveItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# removeReceiveItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/page.mdx new file mode 100644 index 0000000000..d16cafcff4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# removeReturnItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/page.mdx new file mode 100644 index 0000000000..47f2bb5cfa --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateDismissItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateDismissItem/page.mdx new file mode 100644 index 0000000000..93da15477f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateDismissItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateDismissItem + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateDismissItem"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReceiveItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReceiveItem/page.mdx new file mode 100644 index 0000000000..1b4bfe8a84 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReceiveItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateReceiveItem + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReceiveItem"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateRequest/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateRequest/page.mdx new file mode 100644 index 0000000000..7bf11cb9ea --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateRequest/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateRequest + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRequest"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx new file mode 100644 index 0000000000..270d1b7d9b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateReturnItem + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnShipping/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnShipping/page.mdx new file mode 100644 index 0000000000..460fe124de --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnShipping/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateReturnShipping + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateReturnShipping"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Return/properties/js_sdk.admin.Return.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Return/properties/js_sdk.admin.Return.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Return/properties/js_sdk.admin.Return.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.create/page.mdx new file mode 100644 index 0000000000..10581572a6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminReturnReasonParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.delete/page.mdx new file mode 100644 index 0000000000..5b003f903d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx new file mode 100644 index 0000000000..b43ae315a6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="list"/> diff --git a/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/page.mdx new file mode 100644 index 0000000000..ff38c73b72 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/page.mdx new file mode 100644 index 0000000000..f7b34174d0 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[AdminReturnReasonParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminReturnReasonParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ReturnReason/properties/js_sdk.admin.ReturnReason.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ReturnReason/properties/js_sdk.admin.ReturnReason.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ReturnReason/properties/js_sdk.admin.ReturnReason.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/page.mdx new file mode 100644 index 0000000000..2fca33c38b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# batchProducts + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.create/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.create/page.mdx new file mode 100644 index 0000000000..00087c04c5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.delete/page.mdx new file mode 100644 index 0000000000..74d22d0785 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx new file mode 100644 index 0000000000..6d4ad7e6b8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/page.mdx new file mode 100644 index 0000000000..dd7e8b8798 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/page.mdx new file mode 100644 index 0000000000..818858aadb --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/page.mdx new file mode 100644 index 0000000000..480a8b1e0f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateProducts + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/SalesChannel/properties/js_sdk.admin.SalesChannel.client/page.mdx b/www/apps/resources/references/js_sdk/admin/SalesChannel/properties/js_sdk.admin.SalesChannel.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/SalesChannel/properties/js_sdk.admin.SalesChannel.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.comment/page.mdx b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.comment/page.mdx new file mode 100644 index 0000000000..31ad373236 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.comment/page.mdx @@ -0,0 +1,5 @@ +import { TypeList } from "docs-ui" + +# comment + +Ignored by the client. diff --git a/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.data/page.mdx b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.data/page.mdx new file mode 100644 index 0000000000..5aa9573374 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.data/page.mdx @@ -0,0 +1,5 @@ +import { TypeList } from "docs-ui" + +# data + +The data field for the message. Split by new lines. diff --git a/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.event/page.mdx b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.event/page.mdx new file mode 100644 index 0000000000..2290804143 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.event/page.mdx @@ -0,0 +1,5 @@ +import { TypeList } from "docs-ui" + +# event + +A string identifying the type of event described. diff --git a/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.id/page.mdx b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.id/page.mdx new file mode 100644 index 0000000000..51f19550b0 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.id/page.mdx @@ -0,0 +1,5 @@ +import { TypeList } from "docs-ui" + +# id + +The event ID to set the EventSource object's last event ID value. diff --git a/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.retry/page.mdx b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.retry/page.mdx new file mode 100644 index 0000000000..836bde0f45 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.retry/page.mdx @@ -0,0 +1,5 @@ +import { TypeList } from "docs-ui" + +# retry + +The reconnection time. diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/page.mdx new file mode 100644 index 0000000000..19a125d0fc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminCreateShippingOptionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateShippingOptionRule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/page.mdx new file mode 100644 index 0000000000..fb64112071 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx new file mode 100644 index 0000000000..a41b306ff7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/page.mdx new file mode 100644 index 0000000000..168d06fdcc --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/page.mdx new file mode 100644 index 0000000000..66bd0ada2d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../../../fulfillment/types/fulfillment.ShippingOptionPriceType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[AdminCreateShippingOptionType](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateShippingOptionType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"([AdminUpdateShippingOptionPriceWithCurrency](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionPriceWithCurrency/page.mdx) \\| [AdminUpdateShippingOptionPriceWithRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionPriceWithRegion/page.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"([AdminCreateShippingOptionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCreateShippingOptionRule/page.mdx) \\| [AdminUpdateShippingOptionRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateShippingOptionRule/page.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[RuleOperatorType](../../../../../types/CommonTypes/types/types.CommonTypes.RuleOperatorType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/page.mdx new file mode 100644 index 0000000000..7600eb46db --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateRules + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ShippingOption/properties/js_sdk.admin.ShippingOption.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingOption/properties/js_sdk.admin.ShippingOption.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingOption/properties/js_sdk.admin.ShippingOption.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/page.mdx new file mode 100644 index 0000000000..df8f512485 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/page.mdx new file mode 100644 index 0000000000..6a1d932ac8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx new file mode 100644 index 0000000000..1aefec3d05 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/page.mdx new file mode 100644 index 0000000000..94731063b9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/page.mdx new file mode 100644 index 0000000000..3a7d5b63b5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/ShippingProfile/properties/js_sdk.admin.ShippingProfile.client/page.mdx b/www/apps/resources/references/js_sdk/admin/ShippingProfile/properties/js_sdk.admin.ShippingProfile.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/ShippingProfile/properties/js_sdk.admin.ShippingProfile.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/page.mdx new file mode 100644 index 0000000000..edd414d05e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/page.mdx new file mode 100644 index 0000000000..79b0d71995 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# createFulfillmentSet + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.delete/page.mdx new file mode 100644 index 0000000000..7640c7b7d4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx new file mode 100644 index 0000000000..1dd865fbc7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.retrieve/page.mdx new file mode 100644 index 0000000000..ae47494bc4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/page.mdx new file mode 100644 index 0000000000..505e8a18af --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/page.mdx new file mode 100644 index 0000000000..9fa3dac275 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateFulfillmentProviders + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/page.mdx new file mode 100644 index 0000000000..2dd2bf43ac --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# updateSalesChannels + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/StockLocation/properties/js_sdk.admin.StockLocation.client/page.mdx b/www/apps/resources/references/js_sdk/admin/StockLocation/properties/js_sdk.admin.StockLocation.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/StockLocation/properties/js_sdk.admin.StockLocation.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/page.mdx new file mode 100644 index 0000000000..d9b866d115 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/page.mdx new file mode 100644 index 0000000000..04fa967524 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/page.mdx b/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/page.mdx new file mode 100644 index 0000000000..1a2934ce95 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Store/properties/js_sdk.admin.Store.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Store/properties/js_sdk.admin.Store.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Store/properties/js_sdk.admin.Store.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx new file mode 100644 index 0000000000..33bfe0b36c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminTaxRateRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.delete/page.mdx new file mode 100644 index 0000000000..b0c24134d8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx new file mode 100644 index 0000000000..35878bcc6a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.retrieve/page.mdx new file mode 100644 index 0000000000..e1accd0a12 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminTaxRateRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx new file mode 100644 index 0000000000..bd471bcb8d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[AdminTaxRateRule](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRateRule/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="update"/> diff --git a/www/apps/resources/references/js_sdk/admin/TaxRate/properties/js_sdk.admin.TaxRate.client/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRate/properties/js_sdk.admin.TaxRate.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRate/properties/js_sdk.admin.TaxRate.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.create/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.create/page.mdx new file mode 100644 index 0000000000..04fa2e41a2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"[AdminTaxRate](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRate/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`null` \\| [AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="create"/> diff --git a/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.delete/page.mdx new file mode 100644 index 0000000000..bc5b42b7f7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx new file mode 100644 index 0000000000..ac791de5c1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/page.mdx new file mode 100644 index 0000000000..cd9851d1ae --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + +`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"[AdminTaxRate](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRate/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`null` \\| [AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"[AdminTaxRegion](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminTaxRegion/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/> diff --git a/www/apps/resources/references/js_sdk/admin/TaxRegion/properties/js_sdk.admin.TaxRegion.client/page.mdx b/www/apps/resources/references/js_sdk/admin/TaxRegion/properties/js_sdk.admin.TaxRegion.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/TaxRegion/properties/js_sdk.admin.TaxRegion.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.create/page.mdx b/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.create/page.mdx new file mode 100644 index 0000000000..459a9cfad8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/page.mdx new file mode 100644 index 0000000000..c1da1320f8 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/page.mdx new file mode 100644 index 0000000000..33fff69d80 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/Upload/properties/js_sdk.admin.Upload.client/page.mdx b/www/apps/resources/references/js_sdk/admin/Upload/properties/js_sdk.admin.Upload.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/Upload/properties/js_sdk.admin.Upload.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.create/page.mdx b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.create/page.mdx new file mode 100644 index 0000000000..00820a055a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.create/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# create + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/page.mdx b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/page.mdx new file mode 100644 index 0000000000..690f955172 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# delete + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.list/page.mdx b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.list/page.mdx new file mode 100644 index 0000000000..d598bf8293 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.me/page.mdx b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.me/page.mdx new file mode 100644 index 0000000000..46bf112b53 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.me/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# me + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.retrieve/page.mdx new file mode 100644 index 0000000000..d54d901395 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.update/page.mdx b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.update/page.mdx new file mode 100644 index 0000000000..126417c1fe --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/methods/js_sdk.admin.User.update/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# update + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/User/properties/js_sdk.admin.User.client/page.mdx b/www/apps/resources/references/js_sdk/admin/User/properties/js_sdk.admin.User.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/User/properties/js_sdk.admin.User.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx b/www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx new file mode 100644 index 0000000000..a80395c170 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# list + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/page.mdx b/www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/page.mdx new file mode 100644 index 0000000000..3c120a466d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# retrieve + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/WorkflowExecution/properties/js_sdk.admin.WorkflowExecution.client/page.mdx b/www/apps/resources/references/js_sdk/admin/WorkflowExecution/properties/js_sdk.admin.WorkflowExecution.client/page.mdx new file mode 100644 index 0000000000..3b72fb1c1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/WorkflowExecution/properties/js_sdk.admin.WorkflowExecution.client/page.mdx @@ -0,0 +1,223 @@ +import { TypeList } from "docs-ui" + +# client + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## constructor + +### Parameters + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(...`messages`: `string`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new Client"/> + +___ + +`fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences: +- Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise +- You can pass `body` and `query` as objects, and they will be encoded and stringified. +- The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned + +Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type + +## Type Parameters + + + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetch"/> + +## Returns + + + +`fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function. +It follows a very similar interface to `fetch`, with the return value being an async generator. +The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties. +The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field. + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../../../types/js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Returns + + `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fetchStream"/> + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + +## Returns + + Promise<Response>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="initClient"/> + +## Returns + + + +## Returns + + + +## Returns + + + +## Parameters + + + +## Returns + + + +## Returns + + + +## Returns + + + + diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Admin/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Admin/page.mdx new file mode 100644 index 0000000000..3af50c8575 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Admin/page.mdx @@ -0,0 +1,53 @@ +--- +slug: /references/js-sdk/admin +--- + +import { TypeList } from "docs-ui" + +# JS SDK Admin Reference + +The `sdk.admin` class provides methods to send requests to Medusa's Admin API routes. + +## Properties + +- [invite](../../Admin/properties/js_sdk.admin.Admin.invite/page.mdx) +- [customer](../../Admin/properties/js_sdk.admin.Admin.customer/page.mdx) +- [productCollection](../../Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx) +- [productCategory](../../Admin/properties/js_sdk.admin.Admin.productCategory/page.mdx) +- [priceList](../../Admin/properties/js_sdk.admin.Admin.priceList/page.mdx) +- [pricePreference](../../Admin/properties/js_sdk.admin.Admin.pricePreference/page.mdx) +- [product](../../Admin/properties/js_sdk.admin.Admin.product/page.mdx) +- [productType](../../Admin/properties/js_sdk.admin.Admin.productType/page.mdx) +- [upload](../../Admin/properties/js_sdk.admin.Admin.upload/page.mdx) +- [region](../../Admin/properties/js_sdk.admin.Admin.region/page.mdx) +- [returnReason](../../Admin/properties/js_sdk.admin.Admin.returnReason/page.mdx) +- [stockLocation](../../Admin/properties/js_sdk.admin.Admin.stockLocation/page.mdx) +- [salesChannel](../../Admin/properties/js_sdk.admin.Admin.salesChannel/page.mdx) +- [fulfillmentSet](../../Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx) +- [fulfillment](../../Admin/properties/js_sdk.admin.Admin.fulfillment/page.mdx) +- [fulfillmentProvider](../../Admin/properties/js_sdk.admin.Admin.fulfillmentProvider/page.mdx) +- [shippingOption](../../Admin/properties/js_sdk.admin.Admin.shippingOption/page.mdx) +- [shippingProfile](../../Admin/properties/js_sdk.admin.Admin.shippingProfile/page.mdx) +- [inventoryItem](../../Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx) +- [notification](../../Admin/properties/js_sdk.admin.Admin.notification/page.mdx) +- [order](../../Admin/properties/js_sdk.admin.Admin.order/page.mdx) +- [orderEdit](../../Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx) +- [return](../../Admin/properties/js_sdk.admin.Admin.return/page.mdx) +- [claim](../../Admin/properties/js_sdk.admin.Admin.claim/page.mdx) +- [exchange](../../Admin/properties/js_sdk.admin.Admin.exchange/page.mdx) +- [taxRate](../../Admin/properties/js_sdk.admin.Admin.taxRate/page.mdx) +- [taxRegion](../../Admin/properties/js_sdk.admin.Admin.taxRegion/page.mdx) +- [store](../../Admin/properties/js_sdk.admin.Admin.store/page.mdx) +- [productTag](../../Admin/properties/js_sdk.admin.Admin.productTag/page.mdx) +- [user](../../Admin/properties/js_sdk.admin.Admin.user/page.mdx) +- [currency](../../Admin/properties/js_sdk.admin.Admin.currency/page.mdx) +- [payment](../../Admin/properties/js_sdk.admin.Admin.payment/page.mdx) +- [productVariant](../../Admin/properties/js_sdk.admin.Admin.productVariant/page.mdx) +- [refundReason](../../Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx) +- [paymentCollection](../../Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx) +- [apiKey](../../Admin/properties/js_sdk.admin.Admin.apiKey/page.mdx) +- [workflowExecution](../../Admin/properties/js_sdk.admin.Admin.workflowExecution/page.mdx) +- [reservation](../../Admin/properties/js_sdk.admin.Admin.reservation/page.mdx) +- [customerGroup](../../Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx) +- [promotion](../../Admin/properties/js_sdk.admin.Admin.promotion/page.mdx) +- [campaign](../../Admin/properties/js_sdk.admin.Admin.campaign/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ApiKey/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ApiKey/page.mdx new file mode 100644 index 0000000000..b845bfb397 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ApiKey/page.mdx @@ -0,0 +1,17 @@ +import { TypeList } from "docs-ui" + +# ApiKey + +## Properties + +- [client](../../ApiKey/properties/js_sdk.admin.ApiKey.client/page.mdx) + +## Methods + +- [list](../../ApiKey/methods/js_sdk.admin.ApiKey.list/page.mdx) +- [create](../../ApiKey/methods/js_sdk.admin.ApiKey.create/page.mdx) +- [revoke](../../ApiKey/methods/js_sdk.admin.ApiKey.revoke/page.mdx) +- [retrieve](../../ApiKey/methods/js_sdk.admin.ApiKey.retrieve/page.mdx) +- [update](../../ApiKey/methods/js_sdk.admin.ApiKey.update/page.mdx) +- [delete](../../ApiKey/methods/js_sdk.admin.ApiKey.delete/page.mdx) +- [batchSalesChannels](../../ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Campaign/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Campaign/page.mdx new file mode 100644 index 0000000000..f312653094 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Campaign/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# Campaign + +## Properties + +- [client](../../Campaign/properties/js_sdk.admin.Campaign.client/page.mdx) + +## Methods + +- [retrieve](../../Campaign/methods/js_sdk.admin.Campaign.retrieve/page.mdx) +- [list](../../Campaign/methods/js_sdk.admin.Campaign.list/page.mdx) +- [create](../../Campaign/methods/js_sdk.admin.Campaign.create/page.mdx) +- [update](../../Campaign/methods/js_sdk.admin.Campaign.update/page.mdx) +- [delete](../../Campaign/methods/js_sdk.admin.Campaign.delete/page.mdx) +- [batchPromotions](../../Campaign/methods/js_sdk.admin.Campaign.batchPromotions/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Claim/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Claim/page.mdx new file mode 100644 index 0000000000..19c945fbd0 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Claim/page.mdx @@ -0,0 +1,31 @@ +import { TypeList } from "docs-ui" + +# Claim + +## Properties + +- [client](../../Claim/properties/js_sdk.admin.Claim.client/page.mdx) + +## Methods + +- [list](../../Claim/methods/js_sdk.admin.Claim.list/page.mdx) +- [retrieve](../../Claim/methods/js_sdk.admin.Claim.retrieve/page.mdx) +- [create](../../Claim/methods/js_sdk.admin.Claim.create/page.mdx) +- [cancel](../../Claim/methods/js_sdk.admin.Claim.cancel/page.mdx) +- [addItems](../../Claim/methods/js_sdk.admin.Claim.addItems/page.mdx) +- [updateItem](../../Claim/methods/js_sdk.admin.Claim.updateItem/page.mdx) +- [removeItem](../../Claim/methods/js_sdk.admin.Claim.removeItem/page.mdx) +- [addInboundItems](../../Claim/methods/js_sdk.admin.Claim.addInboundItems/page.mdx) +- [updateInboundItem](../../Claim/methods/js_sdk.admin.Claim.updateInboundItem/page.mdx) +- [removeInboundItem](../../Claim/methods/js_sdk.admin.Claim.removeInboundItem/page.mdx) +- [addInboundShipping](../../Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx) +- [updateInboundShipping](../../Claim/methods/js_sdk.admin.Claim.updateInboundShipping/page.mdx) +- [deleteInboundShipping](../../Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/page.mdx) +- [addOutboundItems](../../Claim/methods/js_sdk.admin.Claim.addOutboundItems/page.mdx) +- [updateOutboundItem](../../Claim/methods/js_sdk.admin.Claim.updateOutboundItem/page.mdx) +- [removeOutboundItem](../../Claim/methods/js_sdk.admin.Claim.removeOutboundItem/page.mdx) +- [addOutboundShipping](../../Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx) +- [updateOutboundShipping](../../Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/page.mdx) +- [deleteOutboundShipping](../../Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/page.mdx) +- [request](../../Claim/methods/js_sdk.admin.Claim.request/page.mdx) +- [cancelRequest](../../Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Client/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Client/page.mdx new file mode 100644 index 0000000000..a7b7413d25 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Client/page.mdx @@ -0,0 +1,26 @@ +import { TypeList } from "docs-ui" + +# Client + +## Properties + +- [fetch\_](../../Client/properties/js_sdk.admin.Client.fetch_/page.mdx) +- [config](../../Client/properties/js_sdk.admin.Client.config/page.mdx) +- [logger](../../Client/properties/js_sdk.admin.Client.logger/page.mdx) +- [DEFAULT\_JWT\_STORAGE\_KEY](../../Client/properties/js_sdk.admin.Client.DEFAULT_JWT_STORAGE_KEY/page.mdx) +- [token](../../Client/properties/js_sdk.admin.Client.token/page.mdx) + +## Methods + +- [fetch](../../Client/methods/js_sdk.admin.Client.fetch/page.mdx) +- [fetchStream](../../Client/methods/js_sdk.admin.Client.fetchStream/page.mdx) +- [setToken](../../Client/methods/js_sdk.admin.Client.setToken/page.mdx) +- [clearToken](../../Client/methods/js_sdk.admin.Client.clearToken/page.mdx) +- [clearToken\_](../../Client/methods/js_sdk.admin.Client.clearToken_/page.mdx) +- [initClient](../../Client/methods/js_sdk.admin.Client.initClient/page.mdx) +- [getApiKeyHeader\_](../../Client/methods/js_sdk.admin.Client.getApiKeyHeader_/page.mdx) +- [getPublishableKeyHeader\_](../../Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/page.mdx) +- [getJwtHeader\_](../../Client/methods/js_sdk.admin.Client.getJwtHeader_/page.mdx) +- [setToken\_](../../Client/methods/js_sdk.admin.Client.setToken_/page.mdx) +- [getToken\_](../../Client/methods/js_sdk.admin.Client.getToken_/page.mdx) +- [getTokenStorageInfo\_](../../Client/methods/js_sdk.admin.Client.getTokenStorageInfo_/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Currency/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Currency/page.mdx new file mode 100644 index 0000000000..1466e68195 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Currency/page.mdx @@ -0,0 +1,12 @@ +import { TypeList } from "docs-ui" + +# Currency + +## Properties + +- [client](../../Currency/properties/js_sdk.admin.Currency.client/page.mdx) + +## Methods + +- [list](../../Currency/methods/js_sdk.admin.Currency.list/page.mdx) +- [retrieve](../../Currency/methods/js_sdk.admin.Currency.retrieve/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Customer/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Customer/page.mdx new file mode 100644 index 0000000000..2dd8f3a9fd --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Customer/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# Customer + +## Properties + +- [client](../../Customer/properties/js_sdk.admin.Customer.client/page.mdx) + +## Methods + +- [create](../../Customer/methods/js_sdk.admin.Customer.create/page.mdx) +- [update](../../Customer/methods/js_sdk.admin.Customer.update/page.mdx) +- [list](../../Customer/methods/js_sdk.admin.Customer.list/page.mdx) +- [retrieve](../../Customer/methods/js_sdk.admin.Customer.retrieve/page.mdx) +- [delete](../../Customer/methods/js_sdk.admin.Customer.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.CustomerGroup/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.CustomerGroup/page.mdx new file mode 100644 index 0000000000..bc7870c26b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.CustomerGroup/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# CustomerGroup + +## Properties + +- [client](../../CustomerGroup/properties/js_sdk.admin.CustomerGroup.client/page.mdx) + +## Methods + +- [retrieve](../../CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/page.mdx) +- [list](../../CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/page.mdx) +- [create](../../CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/page.mdx) +- [update](../../CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/page.mdx) +- [delete](../../CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/page.mdx) +- [batchCustomers](../../CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Exchange/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Exchange/page.mdx new file mode 100644 index 0000000000..ef1b3eaa65 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Exchange/page.mdx @@ -0,0 +1,28 @@ +import { TypeList } from "docs-ui" + +# Exchange + +## Properties + +- [client](../../Exchange/properties/js_sdk.admin.Exchange.client/page.mdx) + +## Methods + +- [list](../../Exchange/methods/js_sdk.admin.Exchange.list/page.mdx) +- [retrieve](../../Exchange/methods/js_sdk.admin.Exchange.retrieve/page.mdx) +- [create](../../Exchange/methods/js_sdk.admin.Exchange.create/page.mdx) +- [cancel](../../Exchange/methods/js_sdk.admin.Exchange.cancel/page.mdx) +- [addInboundItems](../../Exchange/methods/js_sdk.admin.Exchange.addInboundItems/page.mdx) +- [updateInboundItem](../../Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/page.mdx) +- [removeInboundItem](../../Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/page.mdx) +- [addInboundShipping](../../Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/page.mdx) +- [updateInboundShipping](../../Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/page.mdx) +- [deleteInboundShipping](../../Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/page.mdx) +- [addOutboundItems](../../Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/page.mdx) +- [updateOutboundItem](../../Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/page.mdx) +- [removeOutboundItem](../../Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/page.mdx) +- [addOutboundShipping](../../Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/page.mdx) +- [updateOutboundShipping](../../Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/page.mdx) +- [deleteOutboundShipping](../../Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/page.mdx) +- [request](../../Exchange/methods/js_sdk.admin.Exchange.request/page.mdx) +- [cancelRequest](../../Exchange/methods/js_sdk.admin.Exchange.cancelRequest/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Fulfillment/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Fulfillment/page.mdx new file mode 100644 index 0000000000..de5ff07c5f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Fulfillment/page.mdx @@ -0,0 +1,13 @@ +import { TypeList } from "docs-ui" + +# Fulfillment + +## Properties + +- [client](../../Fulfillment/properties/js_sdk.admin.Fulfillment.client/page.mdx) + +## Methods + +- [create](../../Fulfillment/methods/js_sdk.admin.Fulfillment.create/page.mdx) +- [cancel](../../Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/page.mdx) +- [createShipment](../../Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentProvider/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentProvider/page.mdx new file mode 100644 index 0000000000..6ac828256e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentProvider/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# FulfillmentProvider + +## Properties + +- [client](../../FulfillmentProvider/properties/js_sdk.admin.FulfillmentProvider.client/page.mdx) + +## Methods + +- [list](../../FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx new file mode 100644 index 0000000000..7e80585a35 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.FulfillmentSet/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# FulfillmentSet + +## Properties + +- [client](../../FulfillmentSet/properties/js_sdk.admin.FulfillmentSet.client/page.mdx) + +## Methods + +- [delete](../../FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/page.mdx) +- [createServiceZone](../../FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/page.mdx) +- [retrieveServiceZone](../../FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.retrieveServiceZone/page.mdx) +- [updateServiceZone](../../FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.updateServiceZone/page.mdx) +- [deleteServiceZone](../../FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.InventoryItem/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.InventoryItem/page.mdx new file mode 100644 index 0000000000..bb1a8abe58 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.InventoryItem/page.mdx @@ -0,0 +1,19 @@ +import { TypeList } from "docs-ui" + +# InventoryItem + +## Properties + +- [client](../../InventoryItem/properties/js_sdk.admin.InventoryItem.client/page.mdx) + +## Methods + +- [create](../../InventoryItem/methods/js_sdk.admin.InventoryItem.create/page.mdx) +- [update](../../InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx) +- [list](../../InventoryItem/methods/js_sdk.admin.InventoryItem.list/page.mdx) +- [retrieve](../../InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/page.mdx) +- [delete](../../InventoryItem/methods/js_sdk.admin.InventoryItem.delete/page.mdx) +- [listLevels](../../InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/page.mdx) +- [updateLevel](../../InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx) +- [deleteLevel](../../InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/page.mdx) +- [batchUpdateLevels](../../InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx new file mode 100644 index 0000000000..f6780701ac --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Invite/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# Invite + +## Properties + +- [client](../../Invite/properties/js_sdk.admin.Invite.client/page.mdx) + +## Methods + +- [accept](../../Invite/methods/js_sdk.admin.Invite.accept/page.mdx) +- [create](../../Invite/methods/js_sdk.admin.Invite.create/page.mdx) +- [retrieve](../../Invite/methods/js_sdk.admin.Invite.retrieve/page.mdx) +- [list](../../Invite/methods/js_sdk.admin.Invite.list/page.mdx) +- [resend](../../Invite/methods/js_sdk.admin.Invite.resend/page.mdx) +- [delete](../../Invite/methods/js_sdk.admin.Invite.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx new file mode 100644 index 0000000000..41126285fd --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Notification/page.mdx @@ -0,0 +1,12 @@ +import { TypeList } from "docs-ui" + +# Notification + +## Properties + +- [client](../../Notification/properties/js_sdk.admin.Notification.client/page.mdx) + +## Methods + +- [retrieve](../../Notification/methods/js_sdk.admin.Notification.retrieve/page.mdx) +- [list](../../Notification/methods/js_sdk.admin.Notification.list/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx new file mode 100644 index 0000000000..cce3b6815e --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Order/page.mdx @@ -0,0 +1,20 @@ +import { TypeList } from "docs-ui" + +# Order + +## Properties + +- [client](../../Order/properties/js_sdk.admin.Order.client/page.mdx) + +## Methods + +- [retrieve](../../Order/methods/js_sdk.admin.Order.retrieve/page.mdx) +- [retrievePreview](../../Order/methods/js_sdk.admin.Order.retrievePreview/page.mdx) +- [list](../../Order/methods/js_sdk.admin.Order.list/page.mdx) +- [cancel](../../Order/methods/js_sdk.admin.Order.cancel/page.mdx) +- [createFulfillment](../../Order/methods/js_sdk.admin.Order.createFulfillment/page.mdx) +- [cancelFulfillment](../../Order/methods/js_sdk.admin.Order.cancelFulfillment/page.mdx) +- [createShipment](../../Order/methods/js_sdk.admin.Order.createShipment/page.mdx) +- [markAsDelivered](../../Order/methods/js_sdk.admin.Order.markAsDelivered/page.mdx) +- [listChanges](../../Order/methods/js_sdk.admin.Order.listChanges/page.mdx) +- [listLineItems](../../Order/methods/js_sdk.admin.Order.listLineItems/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx new file mode 100644 index 0000000000..8cd6241f83 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.OrderEdit/page.mdx @@ -0,0 +1,18 @@ +import { TypeList } from "docs-ui" + +# OrderEdit + +## Properties + +- [client](../../OrderEdit/properties/js_sdk.admin.OrderEdit.client/page.mdx) + +## Methods + +- [initiateRequest](../../OrderEdit/methods/js_sdk.admin.OrderEdit.initiateRequest/page.mdx) +- [request](../../OrderEdit/methods/js_sdk.admin.OrderEdit.request/page.mdx) +- [confirm](../../OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/page.mdx) +- [cancelRequest](../../OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/page.mdx) +- [addItems](../../OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/page.mdx) +- [updateOriginalItem](../../OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/page.mdx) +- [updateAddedItem](../../OrderEdit/methods/js_sdk.admin.OrderEdit.updateAddedItem/page.mdx) +- [removeAddedItem](../../OrderEdit/methods/js_sdk.admin.OrderEdit.removeAddedItem/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx new file mode 100644 index 0000000000..3e25a91629 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Payment/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# Payment + +## Properties + +- [client](../../Payment/properties/js_sdk.admin.Payment.client/page.mdx) + +## Methods + +- [list](../../Payment/methods/js_sdk.admin.Payment.list/page.mdx) +- [listPaymentProviders](../../Payment/methods/js_sdk.admin.Payment.listPaymentProviders/page.mdx) +- [retrieve](../../Payment/methods/js_sdk.admin.Payment.retrieve/page.mdx) +- [capture](../../Payment/methods/js_sdk.admin.Payment.capture/page.mdx) +- [refund](../../Payment/methods/js_sdk.admin.Payment.refund/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx new file mode 100644 index 0000000000..a25aad3227 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PaymentCollection/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# PaymentCollection + +## Properties + +- [client](../../PaymentCollection/properties/js_sdk.admin.PaymentCollection.client/page.mdx) + +## Methods + +- [list](../../PaymentCollection/methods/js_sdk.admin.PaymentCollection.list/page.mdx) +- [retrieve](../../PaymentCollection/methods/js_sdk.admin.PaymentCollection.retrieve/page.mdx) +- [create](../../PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/page.mdx) +- [delete](../../PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/page.mdx) +- [markAsPaid](../../PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PriceList/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PriceList/page.mdx new file mode 100644 index 0000000000..d47ffefb6c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PriceList/page.mdx @@ -0,0 +1,17 @@ +import { TypeList } from "docs-ui" + +# PriceList + +## Properties + +- [client](../../PriceList/properties/js_sdk.admin.PriceList.client/page.mdx) + +## Methods + +- [retrieve](../../PriceList/methods/js_sdk.admin.PriceList.retrieve/page.mdx) +- [list](../../PriceList/methods/js_sdk.admin.PriceList.list/page.mdx) +- [create](../../PriceList/methods/js_sdk.admin.PriceList.create/page.mdx) +- [update](../../PriceList/methods/js_sdk.admin.PriceList.update/page.mdx) +- [delete](../../PriceList/methods/js_sdk.admin.PriceList.delete/page.mdx) +- [batchPrices](../../PriceList/methods/js_sdk.admin.PriceList.batchPrices/page.mdx) +- [linkProducts](../../PriceList/methods/js_sdk.admin.PriceList.linkProducts/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PricePreference/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PricePreference/page.mdx new file mode 100644 index 0000000000..b49e3562c4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.PricePreference/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# PricePreference + +## Properties + +- [client](../../PricePreference/properties/js_sdk.admin.PricePreference.client/page.mdx) + +## Methods + +- [retrieve](../../PricePreference/methods/js_sdk.admin.PricePreference.retrieve/page.mdx) +- [list](../../PricePreference/methods/js_sdk.admin.PricePreference.list/page.mdx) +- [create](../../PricePreference/methods/js_sdk.admin.PricePreference.create/page.mdx) +- [update](../../PricePreference/methods/js_sdk.admin.PricePreference.update/page.mdx) +- [delete](../../PricePreference/methods/js_sdk.admin.PricePreference.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Product/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Product/page.mdx new file mode 100644 index 0000000000..2dd6850446 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Product/page.mdx @@ -0,0 +1,31 @@ +import { TypeList } from "docs-ui" + +# Product + +## Properties + +- [client](../../Product/properties/js_sdk.admin.Product.client/page.mdx) + +## Methods + +- [import](../../Product/methods/js_sdk.admin.Product.import/page.mdx) +- [confirmImport](../../Product/methods/js_sdk.admin.Product.confirmImport/page.mdx) +- [export](../../Product/methods/js_sdk.admin.Product.export/page.mdx) +- [batch](../../Product/methods/js_sdk.admin.Product.batch/page.mdx) +- [create](../../Product/methods/js_sdk.admin.Product.create/page.mdx) +- [update](../../Product/methods/js_sdk.admin.Product.update/page.mdx) +- [list](../../Product/methods/js_sdk.admin.Product.list/page.mdx) +- [retrieve](../../Product/methods/js_sdk.admin.Product.retrieve/page.mdx) +- [delete](../../Product/methods/js_sdk.admin.Product.delete/page.mdx) +- [batchVariants](../../Product/methods/js_sdk.admin.Product.batchVariants/page.mdx) +- [createVariant](../../Product/methods/js_sdk.admin.Product.createVariant/page.mdx) +- [updateVariant](../../Product/methods/js_sdk.admin.Product.updateVariant/page.mdx) +- [listVariants](../../Product/methods/js_sdk.admin.Product.listVariants/page.mdx) +- [retrieveVariant](../../Product/methods/js_sdk.admin.Product.retrieveVariant/page.mdx) +- [deleteVariant](../../Product/methods/js_sdk.admin.Product.deleteVariant/page.mdx) +- [batchVariantInventoryItems](../../Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/page.mdx) +- [createOption](../../Product/methods/js_sdk.admin.Product.createOption/page.mdx) +- [updateOption](../../Product/methods/js_sdk.admin.Product.updateOption/page.mdx) +- [listOptions](../../Product/methods/js_sdk.admin.Product.listOptions/page.mdx) +- [retrieveOption](../../Product/methods/js_sdk.admin.Product.retrieveOption/page.mdx) +- [deleteOption](../../Product/methods/js_sdk.admin.Product.deleteOption/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCategory/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCategory/page.mdx new file mode 100644 index 0000000000..3020ab9b5f --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCategory/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# ProductCategory + +## Properties + +- [client](../../ProductCategory/properties/js_sdk.admin.ProductCategory.client/page.mdx) + +## Methods + +- [create](../../ProductCategory/methods/js_sdk.admin.ProductCategory.create/page.mdx) +- [update](../../ProductCategory/methods/js_sdk.admin.ProductCategory.update/page.mdx) +- [list](../../ProductCategory/methods/js_sdk.admin.ProductCategory.list/page.mdx) +- [retrieve](../../ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/page.mdx) +- [delete](../../ProductCategory/methods/js_sdk.admin.ProductCategory.delete/page.mdx) +- [updateProducts](../../ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCollection/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCollection/page.mdx new file mode 100644 index 0000000000..7ea31799d5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductCollection/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# ProductCollection + +## Properties + +- [client](../../ProductCollection/properties/js_sdk.admin.ProductCollection.client/page.mdx) + +## Methods + +- [create](../../ProductCollection/methods/js_sdk.admin.ProductCollection.create/page.mdx) +- [update](../../ProductCollection/methods/js_sdk.admin.ProductCollection.update/page.mdx) +- [list](../../ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx) +- [retrieve](../../ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/page.mdx) +- [delete](../../ProductCollection/methods/js_sdk.admin.ProductCollection.delete/page.mdx) +- [updateProducts](../../ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductTag/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductTag/page.mdx new file mode 100644 index 0000000000..ad75c15307 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductTag/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# ProductTag + +## Properties + +- [client](../../ProductTag/properties/js_sdk.admin.ProductTag.client/page.mdx) + +## Methods + +- [create](../../ProductTag/methods/js_sdk.admin.ProductTag.create/page.mdx) +- [update](../../ProductTag/methods/js_sdk.admin.ProductTag.update/page.mdx) +- [list](../../ProductTag/methods/js_sdk.admin.ProductTag.list/page.mdx) +- [retrieve](../../ProductTag/methods/js_sdk.admin.ProductTag.retrieve/page.mdx) +- [delete](../../ProductTag/methods/js_sdk.admin.ProductTag.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductType/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductType/page.mdx new file mode 100644 index 0000000000..e3438735b7 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductType/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# ProductType + +## Properties + +- [client](../../ProductType/properties/js_sdk.admin.ProductType.client/page.mdx) + +## Methods + +- [create](../../ProductType/methods/js_sdk.admin.ProductType.create/page.mdx) +- [update](../../ProductType/methods/js_sdk.admin.ProductType.update/page.mdx) +- [list](../../ProductType/methods/js_sdk.admin.ProductType.list/page.mdx) +- [retrieve](../../ProductType/methods/js_sdk.admin.ProductType.retrieve/page.mdx) +- [delete](../../ProductType/methods/js_sdk.admin.ProductType.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductVariant/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductVariant/page.mdx new file mode 100644 index 0000000000..f01c59694c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ProductVariant/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# ProductVariant + +## Properties + +- [client](../../ProductVariant/properties/js_sdk.admin.ProductVariant.client/page.mdx) + +## Methods + +- [list](../../ProductVariant/methods/js_sdk.admin.ProductVariant.list/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Promotion/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Promotion/page.mdx new file mode 100644 index 0000000000..cb8880acbe --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Promotion/page.mdx @@ -0,0 +1,21 @@ +import { TypeList } from "docs-ui" + +# Promotion + +## Properties + +- [client](../../Promotion/properties/js_sdk.admin.Promotion.client/page.mdx) + +## Methods + +- [retrieve](../../Promotion/methods/js_sdk.admin.Promotion.retrieve/page.mdx) +- [list](../../Promotion/methods/js_sdk.admin.Promotion.list/page.mdx) +- [create](../../Promotion/methods/js_sdk.admin.Promotion.create/page.mdx) +- [update](../../Promotion/methods/js_sdk.admin.Promotion.update/page.mdx) +- [delete](../../Promotion/methods/js_sdk.admin.Promotion.delete/page.mdx) +- [addRules](../../Promotion/methods/js_sdk.admin.Promotion.addRules/page.mdx) +- [updateRules](../../Promotion/methods/js_sdk.admin.Promotion.updateRules/page.mdx) +- [removeRules](../../Promotion/methods/js_sdk.admin.Promotion.removeRules/page.mdx) +- [listRules](../../Promotion/methods/js_sdk.admin.Promotion.listRules/page.mdx) +- [listRuleAttributes](../../Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/page.mdx) +- [listRuleValues](../../Promotion/methods/js_sdk.admin.Promotion.listRuleValues/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.RefundReason/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.RefundReason/page.mdx new file mode 100644 index 0000000000..39a362c779 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.RefundReason/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# RefundReason + +## Properties + +- [client](../../RefundReason/properties/js_sdk.admin.RefundReason.client/page.mdx) + +## Methods + +- [list](../../RefundReason/methods/js_sdk.admin.RefundReason.list/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Region/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Region/page.mdx new file mode 100644 index 0000000000..2bf0f3c3a2 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Region/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# Region + +## Properties + +- [client](../../Region/properties/js_sdk.admin.Region.client/page.mdx) + +## Methods + +- [create](../../Region/methods/js_sdk.admin.Region.create/page.mdx) +- [update](../../Region/methods/js_sdk.admin.Region.update/page.mdx) +- [list](../../Region/methods/js_sdk.admin.Region.list/page.mdx) +- [retrieve](../../Region/methods/js_sdk.admin.Region.retrieve/page.mdx) +- [delete](../../Region/methods/js_sdk.admin.Region.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Reservation/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Reservation/page.mdx new file mode 100644 index 0000000000..2fcd9f86e1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Reservation/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# Reservation + +## Properties + +- [client](../../Reservation/properties/js_sdk.admin.Reservation.client/page.mdx) + +## Methods + +- [retrieve](../../Reservation/methods/js_sdk.admin.Reservation.retrieve/page.mdx) +- [list](../../Reservation/methods/js_sdk.admin.Reservation.list/page.mdx) +- [create](../../Reservation/methods/js_sdk.admin.Reservation.create/page.mdx) +- [update](../../Reservation/methods/js_sdk.admin.Reservation.update/page.mdx) +- [delete](../../Reservation/methods/js_sdk.admin.Reservation.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Return/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Return/page.mdx new file mode 100644 index 0000000000..b664ce1724 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Return/page.mdx @@ -0,0 +1,32 @@ +import { TypeList } from "docs-ui" + +# Return + +## Properties + +- [client](../../Return/properties/js_sdk.admin.Return.client/page.mdx) + +## Methods + +- [list](../../Return/methods/js_sdk.admin.Return.list/page.mdx) +- [retrieve](../../Return/methods/js_sdk.admin.Return.retrieve/page.mdx) +- [initiateRequest](../../Return/methods/js_sdk.admin.Return.initiateRequest/page.mdx) +- [cancel](../../Return/methods/js_sdk.admin.Return.cancel/page.mdx) +- [cancelRequest](../../Return/methods/js_sdk.admin.Return.cancelRequest/page.mdx) +- [addReturnItem](../../Return/methods/js_sdk.admin.Return.addReturnItem/page.mdx) +- [updateReturnItem](../../Return/methods/js_sdk.admin.Return.updateReturnItem/page.mdx) +- [removeReturnItem](../../Return/methods/js_sdk.admin.Return.removeReturnItem/page.mdx) +- [addReturnShipping](../../Return/methods/js_sdk.admin.Return.addReturnShipping/page.mdx) +- [updateReturnShipping](../../Return/methods/js_sdk.admin.Return.updateReturnShipping/page.mdx) +- [deleteReturnShipping](../../Return/methods/js_sdk.admin.Return.deleteReturnShipping/page.mdx) +- [updateRequest](../../Return/methods/js_sdk.admin.Return.updateRequest/page.mdx) +- [confirmRequest](../../Return/methods/js_sdk.admin.Return.confirmRequest/page.mdx) +- [initiateReceive](../../Return/methods/js_sdk.admin.Return.initiateReceive/page.mdx) +- [receiveItems](../../Return/methods/js_sdk.admin.Return.receiveItems/page.mdx) +- [updateReceiveItem](../../Return/methods/js_sdk.admin.Return.updateReceiveItem/page.mdx) +- [removeReceiveItem](../../Return/methods/js_sdk.admin.Return.removeReceiveItem/page.mdx) +- [dismissItems](../../Return/methods/js_sdk.admin.Return.dismissItems/page.mdx) +- [updateDismissItem](../../Return/methods/js_sdk.admin.Return.updateDismissItem/page.mdx) +- [removeDismissItem](../../Return/methods/js_sdk.admin.Return.removeDismissItem/page.mdx) +- [confirmReceive](../../Return/methods/js_sdk.admin.Return.confirmReceive/page.mdx) +- [cancelReceive](../../Return/methods/js_sdk.admin.Return.cancelReceive/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ReturnReason/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ReturnReason/page.mdx new file mode 100644 index 0000000000..623202cb1d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ReturnReason/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# ReturnReason + +## Properties + +- [client](../../ReturnReason/properties/js_sdk.admin.ReturnReason.client/page.mdx) + +## Methods + +- [list](../../ReturnReason/methods/js_sdk.admin.ReturnReason.list/page.mdx) +- [retrieve](../../ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/page.mdx) +- [create](../../ReturnReason/methods/js_sdk.admin.ReturnReason.create/page.mdx) +- [update](../../ReturnReason/methods/js_sdk.admin.ReturnReason.update/page.mdx) +- [delete](../../ReturnReason/methods/js_sdk.admin.ReturnReason.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.SalesChannel/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.SalesChannel/page.mdx new file mode 100644 index 0000000000..873b4bf09b --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.SalesChannel/page.mdx @@ -0,0 +1,17 @@ +import { TypeList } from "docs-ui" + +# SalesChannel + +## Properties + +- [client](../../SalesChannel/properties/js_sdk.admin.SalesChannel.client/page.mdx) + +## Methods + +- [create](../../SalesChannel/methods/js_sdk.admin.SalesChannel.create/page.mdx) +- [update](../../SalesChannel/methods/js_sdk.admin.SalesChannel.update/page.mdx) +- [delete](../../SalesChannel/methods/js_sdk.admin.SalesChannel.delete/page.mdx) +- [retrieve](../../SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/page.mdx) +- [list](../../SalesChannel/methods/js_sdk.admin.SalesChannel.list/page.mdx) +- [updateProducts](../../SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/page.mdx) +- [batchProducts](../../SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingOption/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingOption/page.mdx new file mode 100644 index 0000000000..d8cbea920d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingOption/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# ShippingOption + +## Properties + +- [client](../../ShippingOption/properties/js_sdk.admin.ShippingOption.client/page.mdx) + +## Methods + +- [create](../../ShippingOption/methods/js_sdk.admin.ShippingOption.create/page.mdx) +- [retrieve](../../ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/page.mdx) +- [update](../../ShippingOption/methods/js_sdk.admin.ShippingOption.update/page.mdx) +- [delete](../../ShippingOption/methods/js_sdk.admin.ShippingOption.delete/page.mdx) +- [list](../../ShippingOption/methods/js_sdk.admin.ShippingOption.list/page.mdx) +- [updateRules](../../ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingProfile/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingProfile/page.mdx new file mode 100644 index 0000000000..9fed39880d --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.ShippingProfile/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# ShippingProfile + +## Properties + +- [client](../../ShippingProfile/properties/js_sdk.admin.ShippingProfile.client/page.mdx) + +## Methods + +- [create](../../ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/page.mdx) +- [update](../../ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/page.mdx) +- [delete](../../ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/page.mdx) +- [list](../../ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/page.mdx) +- [retrieve](../../ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.StockLocation/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.StockLocation/page.mdx new file mode 100644 index 0000000000..9268dfcaf1 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.StockLocation/page.mdx @@ -0,0 +1,18 @@ +import { TypeList } from "docs-ui" + +# StockLocation + +## Properties + +- [client](../../StockLocation/properties/js_sdk.admin.StockLocation.client/page.mdx) + +## Methods + +- [create](../../StockLocation/methods/js_sdk.admin.StockLocation.create/page.mdx) +- [update](../../StockLocation/methods/js_sdk.admin.StockLocation.update/page.mdx) +- [delete](../../StockLocation/methods/js_sdk.admin.StockLocation.delete/page.mdx) +- [retrieve](../../StockLocation/methods/js_sdk.admin.StockLocation.retrieve/page.mdx) +- [list](../../StockLocation/methods/js_sdk.admin.StockLocation.list/page.mdx) +- [updateSalesChannels](../../StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/page.mdx) +- [createFulfillmentSet](../../StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/page.mdx) +- [updateFulfillmentProviders](../../StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Store/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Store/page.mdx new file mode 100644 index 0000000000..42d72beadb --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Store/page.mdx @@ -0,0 +1,13 @@ +import { TypeList } from "docs-ui" + +# Store + +## Properties + +- [client](../../Store/properties/js_sdk.admin.Store.client/page.mdx) + +## Methods + +- [retrieve](../../Store/methods/js_sdk.admin.Store.retrieve/page.mdx) +- [list](../../Store/methods/js_sdk.admin.Store.list/page.mdx) +- [update](../../Store/methods/js_sdk.admin.Store.update/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRate/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRate/page.mdx new file mode 100644 index 0000000000..f168d2f582 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRate/page.mdx @@ -0,0 +1,15 @@ +import { TypeList } from "docs-ui" + +# TaxRate + +## Properties + +- [client](../../TaxRate/properties/js_sdk.admin.TaxRate.client/page.mdx) + +## Methods + +- [create](../../TaxRate/methods/js_sdk.admin.TaxRate.create/page.mdx) +- [update](../../TaxRate/methods/js_sdk.admin.TaxRate.update/page.mdx) +- [delete](../../TaxRate/methods/js_sdk.admin.TaxRate.delete/page.mdx) +- [retrieve](../../TaxRate/methods/js_sdk.admin.TaxRate.retrieve/page.mdx) +- [list](../../TaxRate/methods/js_sdk.admin.TaxRate.list/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRegion/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRegion/page.mdx new file mode 100644 index 0000000000..53efc349a3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.TaxRegion/page.mdx @@ -0,0 +1,14 @@ +import { TypeList } from "docs-ui" + +# TaxRegion + +## Properties + +- [client](../../TaxRegion/properties/js_sdk.admin.TaxRegion.client/page.mdx) + +## Methods + +- [create](../../TaxRegion/methods/js_sdk.admin.TaxRegion.create/page.mdx) +- [delete](../../TaxRegion/methods/js_sdk.admin.TaxRegion.delete/page.mdx) +- [retrieve](../../TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/page.mdx) +- [list](../../TaxRegion/methods/js_sdk.admin.TaxRegion.list/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Upload/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Upload/page.mdx new file mode 100644 index 0000000000..fb3696a8a9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.Upload/page.mdx @@ -0,0 +1,13 @@ +import { TypeList } from "docs-ui" + +# Upload + +## Properties + +- [client](../../Upload/properties/js_sdk.admin.Upload.client/page.mdx) + +## Methods + +- [create](../../Upload/methods/js_sdk.admin.Upload.create/page.mdx) +- [retrieve](../../Upload/methods/js_sdk.admin.Upload.retrieve/page.mdx) +- [delete](../../Upload/methods/js_sdk.admin.Upload.delete/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.User/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.User/page.mdx new file mode 100644 index 0000000000..d79e945168 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.User/page.mdx @@ -0,0 +1,16 @@ +import { TypeList } from "docs-ui" + +# User + +## Properties + +- [client](../../User/properties/js_sdk.admin.User.client/page.mdx) + +## Methods + +- [create](../../User/methods/js_sdk.admin.User.create/page.mdx) +- [update](../../User/methods/js_sdk.admin.User.update/page.mdx) +- [list](../../User/methods/js_sdk.admin.User.list/page.mdx) +- [retrieve](../../User/methods/js_sdk.admin.User.retrieve/page.mdx) +- [delete](../../User/methods/js_sdk.admin.User.delete/page.mdx) +- [me](../../User/methods/js_sdk.admin.User.me/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.WorkflowExecution/page.mdx b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.WorkflowExecution/page.mdx new file mode 100644 index 0000000000..91adcf430c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/classes/js_sdk.admin.WorkflowExecution/page.mdx @@ -0,0 +1,12 @@ +import { TypeList } from "docs-ui" + +# WorkflowExecution + +## Properties + +- [client](../../WorkflowExecution/properties/js_sdk.admin.WorkflowExecution.client/page.mdx) + +## Methods + +- [list](../../WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/page.mdx) +- [retrieve](../../WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.FetchStreamResponse/page.mdx b/www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.FetchStreamResponse/page.mdx new file mode 100644 index 0000000000..11e01e91f5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.FetchStreamResponse/page.mdx @@ -0,0 +1,8 @@ +import { TypeList } from "docs-ui" + +# FetchStreamResponse + +## Properties + +- [stream](../../FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.stream/page.mdx) +- [abort](../../FetchStreamResponse/properties/js_sdk.admin.FetchStreamResponse.abort/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx b/www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx new file mode 100644 index 0000000000..27fe71abc0 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# ServerSentEventMessage + +## Properties + +- [comment](../../ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.comment/page.mdx) +- [event](../../ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.event/page.mdx) +- [data](../../ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.data/page.mdx) +- [id](../../ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.id/page.mdx) +- [retry](../../ServerSentEventMessage/properties/js_sdk.admin.ServerSentEventMessage.retry/page.mdx) diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientFetch/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientFetch/page.mdx new file mode 100644 index 0000000000..788c57f8e4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientFetch/page.mdx @@ -0,0 +1,11 @@ +import { TypeList } from "docs-ui" + +# ClientFetch + +## Parameters + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"[ClientHeaders](../js_sdk.admin.ClientHeaders/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"body","type":"`RequestInit`[`\"body\"`] \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientHeaders/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientHeaders/page.mdx new file mode 100644 index 0000000000..eea2062e2a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.ClientHeaders/page.mdx @@ -0,0 +1,9 @@ +import { TypeList } from "docs-ui" + +# ClientHeaders + +## tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Config/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Config/page.mdx new file mode 100644 index 0000000000..84a6a02e24 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Config/page.mdx @@ -0,0 +1,171 @@ +import { TypeList } from "docs-ui" + +# Config + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug + +## baseUrl + +___ + +## globalHeaders + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## publishableKey + +___ + +## apiKey + +___ + +## auth + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +### type + +### jwtTokenStorageKey + +### jwtTokenStorageMethod + +___ + +## logger + +### error + +#### Parameters + + + +#### Returns + + + +### warn + +#### Parameters + + + +#### Returns + + + +### info + +#### Parameters + + + +#### Returns + + + +### debug + +#### Parameters + + + +#### Returns + + + +___ + +## debug diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchArgs/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchArgs/page.mdx new file mode 100644 index 0000000000..61d766eea4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchArgs/page.mdx @@ -0,0 +1,19 @@ +import { TypeList } from "docs-ui" + +# FetchArgs + +## query + +___ + +## headers + +### tags + +Tags to cache data under for Next.js applications. + +Learn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag). + +___ + +## body diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchInput/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchInput/page.mdx new file mode 100644 index 0000000000..6adeabaf0c --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchInput/page.mdx @@ -0,0 +1,3 @@ +import { TypeList } from "docs-ui" + +# FetchInput diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchParams/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchParams/page.mdx new file mode 100644 index 0000000000..65a776472a --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.FetchParams/page.mdx @@ -0,0 +1,3 @@ +import { TypeList } from "docs-ui" + +# FetchParams diff --git a/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Logger/page.mdx b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Logger/page.mdx new file mode 100644 index 0000000000..fcfc9c1451 --- /dev/null +++ b/www/apps/resources/references/js_sdk/admin/types/js_sdk.admin.Logger/page.mdx @@ -0,0 +1,95 @@ +import { TypeList } from "docs-ui" + +# Logger + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + + +## error + +### Parameters + + + +### Returns + + + +___ + +## warn + +### Parameters + + + +### Returns + + + +___ + +## info + +### Parameters + + + +### Returns + + + +___ + +## debug + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.callback/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.callback/page.mdx new file mode 100644 index 0000000000..f52a0c3db3 --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.callback/page.mdx @@ -0,0 +1,35 @@ +--- +slug: /references/js-sdk/auth/callback +sidebar_label: callback +--- + +import { TypeList } from "docs-ui" + +# callback - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.callback` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types. +It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_providercallback). + +## Example + +```ts +sdk.auth.callback( + "customer", + "google", + { + code: "123", + } +).then((token) => { + console.log(token) +}) +``` + +## Parameters + +`","description":"The query parameters from the Oauth callback, which should be passed to the API route.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="callback"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.login/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.login/page.mdx new file mode 100644 index 0000000000..f56f8cf40d --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.login/page.mdx @@ -0,0 +1,42 @@ +--- +slug: /references/js-sdk/auth/login +sidebar_label: login +--- + +import { TypeList } from "docs-ui" + +# login - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.login` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method retrieves the JWT authenticated token for an admin user, customer, or custom +actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_provider). + +If the `auth.type` of the SDK is set to `session`, this method will also send a request to the +[Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth\_postsession). + +Subsequent requests using the SDK will automatically have the necessary authentication headers / session +set. + +## Example + +```ts +sdk.auth.login( + "customer", + "emailpass", + { + email: "customer@gmail.com", + password: "supersecret" + } +).then((token) => { + console.log(token) +}) +``` + +## Parameters + +`","description":"The data to pass in the request's body for authentication. When using the `emailpass` provider,\nyou pass the email and password.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="login"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.logout/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.logout/page.mdx new file mode 100644 index 0000000000..e9ec030275 --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.logout/page.mdx @@ -0,0 +1,26 @@ +--- +slug: /references/js-sdk/auth/logout +sidebar_label: logout +--- + +import { TypeList } from "docs-ui" + +# logout - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.logout` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method deletes the authentication session of the currently logged-in user to log them out. +It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth\_deletesession). + +## Example + +```ts +sdk.auth.logout() +.then(() => { + // user is logged out +}) +``` + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.refresh/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.refresh/page.mdx new file mode 100644 index 0000000000..d2e9835203 --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.refresh/page.mdx @@ -0,0 +1,26 @@ +--- +slug: /references/js-sdk/auth/refresh +sidebar_label: refresh +--- + +import { TypeList } from "docs-ui" + +# refresh - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.refresh` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method refreshes a JWT authentication token, which is useful after validating the Oauth callback +with [callback](../js_sdk.auth.Auth.callback/page.mdx). It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth\_postadminauthtokenrefresh). + +## Example + +```ts +sdk.auth.refresh() +.then((token) => { + console.log(token) +}) +``` + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.register/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.register/page.mdx new file mode 100644 index 0000000000..568cab4470 --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.register/page.mdx @@ -0,0 +1,34 @@ +--- +slug: /references/js-sdk/auth/register +sidebar_label: register +--- + +import { TypeList } from "docs-ui" + +# register - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.register` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the +[Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth\_postactor\_typeauth\_provider\_register). + +## Example + +```ts +sdk.auth + .register("customer", "emailpass", { + email: "customer@gmail.com", + password: "supersecret", + } + .then((token) => { + console.log(token) + }) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.resetPassword/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.resetPassword/page.mdx new file mode 100644 index 0000000000..7faecbb854 --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.resetPassword/page.mdx @@ -0,0 +1,40 @@ +--- +slug: /references/js-sdk/auth/resetPassword +sidebar_label: resetPassword +--- + +import { TypeList } from "docs-ui" + +# resetPassword - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.resetPassword` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method requests a reset password token for an admin user, customer, or custom actor type. +It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_providerresetpassword). + +To reset the password later using the token delivered to the user, use the [updateProvider](../js_sdk.auth.Auth.updateProvider/page.mdx) method. + +Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password). + +## Example + +```ts +sdk.auth.resetPassword( + "customer", + "emailpass", + { + identifier: "customer@gmail.com" + } +) +.then(() => { + // user receives token +}) +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.updateProvider/page.mdx b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.updateProvider/page.mdx new file mode 100644 index 0000000000..d6f9d3655e --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/Auth/methods/js_sdk.auth.Auth.updateProvider/page.mdx @@ -0,0 +1,43 @@ +--- +slug: /references/js-sdk/auth/updateProvider +sidebar_label: updateProvider +--- + +import { TypeList } from "docs-ui" + +# updateProvider - JS SDK Auth Reference + +This documentation provides a reference to the `sdk.auth.updateProvider` method used to send requests to Medusa's Authentication API routes. It can be used for admin users, customers, or custom actor types. + +This method is used to update user-related data authentication data. + +More specifically, use this method when updating the password of an admin user, customer, or +custom actor type after requesting to reset their password with [resetPassword](../js_sdk.auth.Auth.resetPassword/page.mdx). + +This method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth\_postactor\_typeauth\_providerupdate). + +Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password). + +## Example + +```ts +sdk.auth.updateProvider( + "customer", + "emailpass", + { + email: "customer@gmail.com", + password: "supersecret" + } +) +.then(() => { + // password updated +}) +``` + +## Parameters + +`","description":"The data necessary to update the user's authentication data. When resetting the user's password, \nsend the `email` and `password` properties.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/> + +## Returns + + diff --git a/www/apps/resources/references/js_sdk/auth/classes/js_sdk.auth.Auth/page.mdx b/www/apps/resources/references/js_sdk/auth/classes/js_sdk.auth.Auth/page.mdx new file mode 100644 index 0000000000..591def3ff5 --- /dev/null +++ b/www/apps/resources/references/js_sdk/auth/classes/js_sdk.auth.Auth/page.mdx @@ -0,0 +1,19 @@ +--- +slug: /references/js-sdk/auth +--- + +import { TypeList } from "docs-ui" + +# JS SDK Auth Reference + +The `sdk.auth` class provides methods to send requests to manage a user or customer's authentication + +## Methods + +- [register](../../Auth/methods/js_sdk.auth.Auth.register/page.mdx) +- [login](../../Auth/methods/js_sdk.auth.Auth.login/page.mdx) +- [callback](../../Auth/methods/js_sdk.auth.Auth.callback/page.mdx) +- [refresh](../../Auth/methods/js_sdk.auth.Auth.refresh/page.mdx) +- [logout](../../Auth/methods/js_sdk.auth.Auth.logout/page.mdx) +- [resetPassword](../../Auth/methods/js_sdk.auth.Auth.resetPassword/page.mdx) +- [updateProvider](../../Auth/methods/js_sdk.auth.Auth.updateProvider/page.mdx) diff --git a/www/apps/resources/references/js_sdk/modules/js_sdk.admin/page.mdx b/www/apps/resources/references/js_sdk/modules/js_sdk.admin/page.mdx new file mode 100644 index 0000000000..27051d8fb9 --- /dev/null +++ b/www/apps/resources/references/js_sdk/modules/js_sdk.admin/page.mdx @@ -0,0 +1,64 @@ +import { TypeList } from "docs-ui" + +# admin + +## Classes + +- [ApiKey](../../admin/classes/js_sdk.admin.ApiKey/page.mdx) +- [Campaign](../../admin/classes/js_sdk.admin.Campaign/page.mdx) +- [Claim](../../admin/classes/js_sdk.admin.Claim/page.mdx) +- [Currency](../../admin/classes/js_sdk.admin.Currency/page.mdx) +- [CustomerGroup](../../admin/classes/js_sdk.admin.CustomerGroup/page.mdx) +- [Customer](../../admin/classes/js_sdk.admin.Customer/page.mdx) +- [Exchange](../../admin/classes/js_sdk.admin.Exchange/page.mdx) +- [FulfillmentProvider](../../admin/classes/js_sdk.admin.FulfillmentProvider/page.mdx) +- [FulfillmentSet](../../admin/classes/js_sdk.admin.FulfillmentSet/page.mdx) +- [Fulfillment](../../admin/classes/js_sdk.admin.Fulfillment/page.mdx) +- [Admin](../../admin/classes/js_sdk.admin.Admin/page.mdx) +- [InventoryItem](../../admin/classes/js_sdk.admin.InventoryItem/page.mdx) +- [Invite](../../admin/classes/js_sdk.admin.Invite/page.mdx) +- [Notification](../../admin/classes/js_sdk.admin.Notification/page.mdx) +- [OrderEdit](../../admin/classes/js_sdk.admin.OrderEdit/page.mdx) +- [Order](../../admin/classes/js_sdk.admin.Order/page.mdx) +- [PaymentCollection](../../admin/classes/js_sdk.admin.PaymentCollection/page.mdx) +- [Payment](../../admin/classes/js_sdk.admin.Payment/page.mdx) +- [PriceList](../../admin/classes/js_sdk.admin.PriceList/page.mdx) +- [PricePreference](../../admin/classes/js_sdk.admin.PricePreference/page.mdx) +- [ProductCategory](../../admin/classes/js_sdk.admin.ProductCategory/page.mdx) +- [ProductCollection](../../admin/classes/js_sdk.admin.ProductCollection/page.mdx) +- [ProductTag](../../admin/classes/js_sdk.admin.ProductTag/page.mdx) +- [ProductType](../../admin/classes/js_sdk.admin.ProductType/page.mdx) +- [ProductVariant](../../admin/classes/js_sdk.admin.ProductVariant/page.mdx) +- [Product](../../admin/classes/js_sdk.admin.Product/page.mdx) +- [Promotion](../../admin/classes/js_sdk.admin.Promotion/page.mdx) +- [RefundReason](../../admin/classes/js_sdk.admin.RefundReason/page.mdx) +- [Region](../../admin/classes/js_sdk.admin.Region/page.mdx) +- [Reservation](../../admin/classes/js_sdk.admin.Reservation/page.mdx) +- [ReturnReason](../../admin/classes/js_sdk.admin.ReturnReason/page.mdx) +- [Return](../../admin/classes/js_sdk.admin.Return/page.mdx) +- [SalesChannel](../../admin/classes/js_sdk.admin.SalesChannel/page.mdx) +- [ShippingOption](../../admin/classes/js_sdk.admin.ShippingOption/page.mdx) +- [ShippingProfile](../../admin/classes/js_sdk.admin.ShippingProfile/page.mdx) +- [StockLocation](../../admin/classes/js_sdk.admin.StockLocation/page.mdx) +- [Store](../../admin/classes/js_sdk.admin.Store/page.mdx) +- [TaxRate](../../admin/classes/js_sdk.admin.TaxRate/page.mdx) +- [TaxRegion](../../admin/classes/js_sdk.admin.TaxRegion/page.mdx) +- [Upload](../../admin/classes/js_sdk.admin.Upload/page.mdx) +- [User](../../admin/classes/js_sdk.admin.User/page.mdx) +- [WorkflowExecution](../../admin/classes/js_sdk.admin.WorkflowExecution/page.mdx) +- [Client](../../admin/classes/js_sdk.admin.Client/page.mdx) + +## Interfaces + +- [ServerSentEventMessage](../../admin/interfaces/js_sdk.admin.ServerSentEventMessage/page.mdx) +- [FetchStreamResponse](../../admin/interfaces/js_sdk.admin.FetchStreamResponse/page.mdx) + +## Type Aliases + +- [Logger](../../admin/types/js_sdk.admin.Logger/page.mdx) +- [Config](../../admin/types/js_sdk.admin.Config/page.mdx) +- [FetchParams](../../admin/types/js_sdk.admin.FetchParams/page.mdx) +- [ClientHeaders](../../admin/types/js_sdk.admin.ClientHeaders/page.mdx) +- [FetchInput](../../admin/types/js_sdk.admin.FetchInput/page.mdx) +- [FetchArgs](../../admin/types/js_sdk.admin.FetchArgs/page.mdx) +- [ClientFetch](../../admin/types/js_sdk.admin.ClientFetch/page.mdx) diff --git a/www/apps/resources/references/js_sdk/modules/js_sdk.auth/page.mdx b/www/apps/resources/references/js_sdk/modules/js_sdk.auth/page.mdx new file mode 100644 index 0000000000..55882ab434 --- /dev/null +++ b/www/apps/resources/references/js_sdk/modules/js_sdk.auth/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# auth + +## Classes + +- [Auth](../../auth/classes/js_sdk.auth.Auth/page.mdx) diff --git a/www/apps/resources/references/js_sdk/modules/js_sdk.store/page.mdx b/www/apps/resources/references/js_sdk/modules/js_sdk.store/page.mdx new file mode 100644 index 0000000000..c91206daa4 --- /dev/null +++ b/www/apps/resources/references/js_sdk/modules/js_sdk.store/page.mdx @@ -0,0 +1,7 @@ +import { TypeList } from "docs-ui" + +# store + +## Classes + +- [Store](../../store/classes/js_sdk.store.Store/page.mdx) diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx new file mode 100644 index 0000000000..c0d46c6b76 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx @@ -0,0 +1,510 @@ +--- +slug: /references/js-sdk/admin/cart +sidebar_label: cart +--- + +import { TypeList } from "docs-ui" + +# cart - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.cart` set of methods used to send requests to Medusa's Store API routes. + +Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart). + +## create + +This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/v2/api/store#carts\_postcarts) +API route. + +Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/create). + +### Example + +```ts +sdk.store.cart.create({ + region_id: "reg_123" +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +This method updates a cart. It sends a request to the +[Update Cart](https://docs.medusajs.com/v2/api/store#carts\_postcartsid) API route. + +Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/update). + +### Example + +```ts +sdk.store.cart.update("cart_123", { + region_id: "reg_123" +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a cart by its ID. It sends a request to the +[Get Cart](https://docs.medusajs.com/v2/api/store#carts\_getcartsid) API route. + +Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/retrieve). + +### Example + +To retrieve a cart by its ID: + +```ts +sdk.store.cart.retrieve("cart_123") +.then(({ cart }) => { + console.log(cart) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.cart.retrieve("cart_123", { + fields: "id,*items" +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## createLineItem + +This methods adds a product variant to the cart as a line item. It sends a request to the +[Add Line Item](https://docs.medusajs.com/v2/api/store#carts\_postcartsidlineitems) API route. + +Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items). + +### Example + +```ts +sdk.store.cart.createLineItem("cart_123", { + variant_id: "variant_123", + quantity: 1 +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## updateLineItem + +This method updates a line item in a cart. It sends a request to the +[Update Line Item](https://docs.medusajs.com/v2/api/store#carts\_postcartsidlineitemsline\_id) API route. + +Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items). + +### Example + +```ts +sdk.store.cart.updateLineItem( + "cart_123", + "li_123", + { + quantity: 1 + } +) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## deleteLineItem + +This method deletes a line item from a cart. It sends a request to the +[Remove Line Item](https://docs.medusajs.com/v2/api/store#carts\_deletecartsidlineitemsline\_id) API route. + +Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items). + +### Example + +```ts +sdk.store.cart.deleteLineItem( + "cart_123", + "li_123" +) +.then(({ deleted, parent: cart }) => { + console.log(deleted, cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## addShippingMethod + +This method adds a shipping method to a cart. It sends a request to +the [Add Shipping Method](https://docs.medusajs.com/v2/api/store#carts\_postcartsidshippingmethods) API routes. + +Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping). + +### Example + +```ts +sdk.store.cart.addShippingMethod("cart_123", { + option_id: "so_123", + data: { + // custom data for fulfillment provider. + } +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## complete + +This method completes a cart and places the order. It's the last step of the checkout flow. +The method sends a request to the [Complete Cart](https://docs.medusajs.com/v2/api/store#carts\_postcartsidcomplete) +API route. + +Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart). + +### Example + +```ts +sdk.store.cart.complete("cart_123") +.then((data) => { + if(data.type === "cart") { + // an error occurred + console.log(data.error, data.cart) + } else { + // order placed successfully + console.log(data.order) + } +}) +``` + +### Parameters + + + +### Returns + + + +## create + +This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/v2/api/store#carts\_postcarts) +API route. + +Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/create). + +### Example + +```ts +sdk.store.cart.create({ + region_id: "reg_123" +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +This method updates a cart. It sends a request to the +[Update Cart](https://docs.medusajs.com/v2/api/store#carts\_postcartsid) API route. + +Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/update). + +### Example + +```ts +sdk.store.cart.update("cart_123", { + region_id: "reg_123" +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a cart by its ID. It sends a request to the +[Get Cart](https://docs.medusajs.com/v2/api/store#carts\_getcartsid) API route. + +Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/retrieve). + +### Example + +To retrieve a cart by its ID: + +```ts +sdk.store.cart.retrieve("cart_123") +.then(({ cart }) => { + console.log(cart) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.cart.retrieve("cart_123", { + fields: "id,*items" +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## createLineItem + +This methods adds a product variant to the cart as a line item. It sends a request to the +[Add Line Item](https://docs.medusajs.com/v2/api/store#carts\_postcartsidlineitems) API route. + +Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items). + +### Example + +```ts +sdk.store.cart.createLineItem("cart_123", { + variant_id: "variant_123", + quantity: 1 +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## updateLineItem + +This method updates a line item in a cart. It sends a request to the +[Update Line Item](https://docs.medusajs.com/v2/api/store#carts\_postcartsidlineitemsline\_id) API route. + +Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items). + +### Example + +```ts +sdk.store.cart.updateLineItem( + "cart_123", + "li_123", + { + quantity: 1 + } +) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## deleteLineItem + +This method deletes a line item from a cart. It sends a request to the +[Remove Line Item](https://docs.medusajs.com/v2/api/store#carts\_deletecartsidlineitemsline\_id) API route. + +Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items). + +### Example + +```ts +sdk.store.cart.deleteLineItem( + "cart_123", + "li_123" +) +.then(({ deleted, parent: cart }) => { + console.log(deleted, cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## addShippingMethod + +This method adds a shipping method to a cart. It sends a request to +the [Add Shipping Method](https://docs.medusajs.com/v2/api/store#carts\_postcartsidshippingmethods) API routes. + +Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping). + +### Example + +```ts +sdk.store.cart.addShippingMethod("cart_123", { + option_id: "so_123", + data: { + // custom data for fulfillment provider. + } +}) +.then(({ cart }) => { + console.log(cart) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## complete + +This method completes a cart and places the order. It's the last step of the checkout flow. +The method sends a request to the [Complete Cart](https://docs.medusajs.com/v2/api/store#carts\_postcartsidcomplete) +API route. + +Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart). + +### Example + +```ts +sdk.store.cart.complete("cart_123") +.then((data) => { + if(data.type === "cart") { + // an error occurred + console.log(data.error, data.cart) + } else { + // order placed successfully + console.log(data.order) + } +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx new file mode 100644 index 0000000000..546cba3880 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx @@ -0,0 +1,200 @@ +--- +slug: /references/js-sdk/admin/category +sidebar_label: category +--- + +import { TypeList } from "docs-ui" + +# category - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.category` set of methods used to send requests to Medusa's Store API routes. + +## list + +This method retrieves a paginated list of product categories. It sends a request to the +[List Categories](https://docs.medusajs.com/v2/api/store#product-categories\_getproductcategories) API route. + +Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list). + +### Example + +To retrieve the list of categoreis: + +```ts +sdk.store.category.list() +.then(({ product_categories, count, offset, limit }) => { + console.log(product_categories) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.category.list({ + limit: 10, + offset: 10 +}) +.then(({ product_categories, count, offset, limit }) => { + console.log(product_categories) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each category: + +```ts +sdk.store.category.list({ + fields: "id,*parent_category" +}) +.then(({ product_categories, count, offset, limit }) => { + console.log(product_categories) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a category by its ID. It sends a request to the +[Retrieve Product Category](https://docs.medusajs.com/v2/api/store#product-categories\_getproductcategoriesid). + +Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve). + +### Example + +To retrieve a category by its ID: + +```ts +sdk.store.category.retrieve("pcat_123") +.then(({ product_category }) => { + console.log(product_category) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.category.retrieve("pcat_123", { + fields: "id,*parent_category" +}) +.then(({ product_category }) => { + console.log(product_category) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +## list + +This method retrieves a paginated list of product categories. It sends a request to the +[List Categories](https://docs.medusajs.com/v2/api/store#product-categories\_getproductcategories) API route. + +Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list). + +### Example + +To retrieve the list of categoreis: + +```ts +sdk.store.category.list() +.then(({ product_categories, count, offset, limit }) => { + console.log(product_categories) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.category.list({ + limit: 10, + offset: 10 +}) +.then(({ product_categories, count, offset, limit }) => { + console.log(product_categories) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each category: + +```ts +sdk.store.category.list({ + fields: "id,*parent_category" +}) +.then(({ product_categories, count, offset, limit }) => { + console.log(product_categories) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a category by its ID. It sends a request to the +[Retrieve Product Category](https://docs.medusajs.com/v2/api/store#product-categories\_getproductcategoriesid). + +Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve). + +### Example + +To retrieve a category by its ID: + +```ts +sdk.store.category.retrieve("pcat_123") +.then(({ product_category }) => { + console.log(product_category) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.category.retrieve("pcat_123", { + fields: "id,*parent_category" +}) +.then(({ product_category }) => { + console.log(product_category) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx new file mode 100644 index 0000000000..995ca652f0 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.collection/page.mdx @@ -0,0 +1,200 @@ +--- +slug: /references/js-sdk/admin/collection +sidebar_label: collection +--- + +import { TypeList } from "docs-ui" + +# collection - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.collection` set of methods used to send requests to Medusa's Store API routes. + +## list + +This method retrieves a paginated list of product collections. It sends a request to the +[List Collections](https://docs.medusajs.com/v2/api/store#collections\_getcollections) API route. + +Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list). + +### Example + +To retrieve the list of collections: + +```ts +sdk.store.collection.list() +.then(({ collections, count, limit, offset }) => { + console.log(collections) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.collection.list({ + limit: 10, + offset: 10 +}) +.then(({ collections, count, limit, offset }) => { + console.log(collections) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each collection: + +```ts +sdk.store.collection.list({ + fields: "id,handle" +}) +.then(({ collections, count, limit, offset }) => { + console.log(collections) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/v2/api/store#collections\_getcollectionsid) +API route. + +Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve). + +### Example + +To retrieve a collection by its ID: + +```ts +sdk.store.collection.retrieve("pcol_123") +.then(({ collection }) => { + console.log(collection) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.collection.retrieve("pcol_123", { + fields: "id,handle" +}) +.then(({ collection }) => { + console.log(collection) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +## list + +This method retrieves a paginated list of product collections. It sends a request to the +[List Collections](https://docs.medusajs.com/v2/api/store#collections\_getcollections) API route. + +Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list). + +### Example + +To retrieve the list of collections: + +```ts +sdk.store.collection.list() +.then(({ collections, count, limit, offset }) => { + console.log(collections) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.collection.list({ + limit: 10, + offset: 10 +}) +.then(({ collections, count, limit, offset }) => { + console.log(collections) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each collection: + +```ts +sdk.store.collection.list({ + fields: "id,handle" +}) +.then(({ collections, count, limit, offset }) => { + console.log(collections) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/v2/api/store#collections\_getcollectionsid) +API route. + +Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve). + +### Example + +To retrieve a collection by its ID: + +```ts +sdk.store.collection.retrieve("pcol_123") +.then(({ collection }) => { + console.log(collection) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.collection.retrieve("pcol_123", { + fields: "id,handle" +}) +.then(({ collection }) => { + console.log(collection) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx new file mode 100644 index 0000000000..2d03abf41d --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx @@ -0,0 +1,610 @@ +--- +slug: /references/js-sdk/admin/customer +sidebar_label: customer +--- + +import { TypeList } from "docs-ui" + +# customer - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.customer` set of methods used to send requests to Medusa's Store API routes. + +## create + +This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/v2/api/store#customers\_postcustomers) +API route. + +You must use the Auth.register method first to retrieve a registration token. Then, pass that +registration token in the `headers` parameter of this method as an authorization bearer header. + +Related guide: [How to register customer in storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/register) + +### Example + +```ts +const token = await sdk.auth.register("customer", "emailpass", { + "email": "customer@gmail.com", + "password": "supersecret" +}) + +sdk.store.customer.create( + { + "email": "customer@gmail.com" + }, + {}, + { + authorization: `Bearer ${token}` + } +) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +This method updates the logged-in customer's details. The customer must be logged in +first with the Auth.login method. + +It sends a request to the +[Update Customer](https://docs.medusajs.com/v2/api/store#customers\_postcustomersme) API route. + +Related guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/profile). + +### Example + +```ts +sdk.store.customer.update({ + first_name: "John" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves the logged-in customer's details. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/v2/api/store#customers\_getcustomersme) +API route. + +### Example + +```ts +sdk.store.customer.retrieve() +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## createAddress + +This method creates an address for the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Create Address](https://docs.medusajs.com/v2/api/store#customers\_postcustomersmeaddresses) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +```ts +sdk.store.customer.createAddress({ + country_code: "us" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## updateAddress + +This method updates the address of the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Update Address](https://docs.medusajs.com/v2/api/store#customers\_postcustomersmeaddressesaddress\_id) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +```ts +sdk.store.customer.updateAddress( + "caddr_123", + { + country_code: "us" + } +) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## listAddress + +This method retrieves the logged-in customer's address. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [List Customer's Address](https://docs.medusajs.com/v2/api/store#customers\_getcustomersmeaddresses) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +To retrieve the list of addresses: + +```ts +sdk.store.customer.listAddress() +.then(({ addresses, count, offset, limit }) => { + console.log(addresses) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.customer.listAddress({ + limit: 10, + offset: 10 +}) +.then(({ addresses, count, offset, limit }) => { + console.log(addresses) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each address: + +```ts +sdk.store.customer.listAddress({ + fields: "id,country_code" +}) +.then(({ addresses, count, offset, limit }) => { + console.log(addresses) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieveAddress + +This method retrieves an address of the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Get Address](https://docs.medusajs.com/v2/api/store#customers\_getcustomersmeaddressesaddress\_id) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +To retrieve an address by its ID: + +```ts +sdk.store.customer.retrieveAddress( + "caddr_123" +) +.then(({ address }) => { + console.log(address) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.customer.retrieveAddress( + "caddr_123", + { + fields: "id,country_code" + } +) +.then(({ address }) => { + console.log(address) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## deleteAddress + +This method deletes an address of the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Remove Address](https://docs.medusajs.com/v2/api/store#customers\_deletecustomersmeaddressesaddress\_id) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +```ts +sdk.store.customer.deleteAddress("caddr_123") +.then(({ deleted, parent: customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +## create + +This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/v2/api/store#customers\_postcustomers) +API route. + +You must use the Auth.register method first to retrieve a registration token. Then, pass that +registration token in the `headers` parameter of this method as an authorization bearer header. + +Related guide: [How to register customer in storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/register) + +### Example + +```ts +const token = await sdk.auth.register("customer", "emailpass", { + "email": "customer@gmail.com", + "password": "supersecret" +}) + +sdk.store.customer.create( + { + "email": "customer@gmail.com" + }, + {}, + { + authorization: `Bearer ${token}` + } +) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## update + +This method updates the logged-in customer's details. The customer must be logged in +first with the Auth.login method. + +It sends a request to the +[Update Customer](https://docs.medusajs.com/v2/api/store#customers\_postcustomersme) API route. + +Related guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/profile). + +### Example + +```ts +sdk.store.customer.update({ + first_name: "John" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves the logged-in customer's details. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/v2/api/store#customers\_getcustomersme) +API route. + +### Example + +```ts +sdk.store.customer.retrieve() +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## createAddress + +This method creates an address for the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Create Address](https://docs.medusajs.com/v2/api/store#customers\_postcustomersmeaddresses) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +```ts +sdk.store.customer.createAddress({ + country_code: "us" +}) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## updateAddress + +This method updates the address of the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Update Address](https://docs.medusajs.com/v2/api/store#customers\_postcustomersmeaddressesaddress\_id) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +```ts +sdk.store.customer.updateAddress( + "caddr_123", + { + country_code: "us" + } +) +.then(({ customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + + +___ + +## listAddress + +This method retrieves the logged-in customer's address. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [List Customer's Address](https://docs.medusajs.com/v2/api/store#customers\_getcustomersmeaddresses) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +To retrieve the list of addresses: + +```ts +sdk.store.customer.listAddress() +.then(({ addresses, count, offset, limit }) => { + console.log(addresses) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.customer.listAddress({ + limit: 10, + offset: 10 +}) +.then(({ addresses, count, offset, limit }) => { + console.log(addresses) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each address: + +```ts +sdk.store.customer.listAddress({ + fields: "id,country_code" +}) +.then(({ addresses, count, offset, limit }) => { + console.log(addresses) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieveAddress + +This method retrieves an address of the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Get Address](https://docs.medusajs.com/v2/api/store#customers\_getcustomersmeaddressesaddress\_id) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +To retrieve an address by its ID: + +```ts +sdk.store.customer.retrieveAddress( + "caddr_123" +) +.then(({ address }) => { + console.log(address) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.customer.retrieveAddress( + "caddr_123", + { + fields: "id,country_code" + } +) +.then(({ address }) => { + console.log(address) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## deleteAddress + +This method deletes an address of the logged-in customer. The customer must be logged in +first with the Auth.login method. + +It sends a request to the [Remove Address](https://docs.medusajs.com/v2/api/store#customers\_deletecustomersmeaddressesaddress\_id) +API route. + +Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses) + +### Example + +```ts +sdk.store.customer.deleteAddress("caddr_123") +.then(({ deleted, parent: customer }) => { + console.log(customer) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx new file mode 100644 index 0000000000..8d11c3bc27 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.fulfillment/page.mdx @@ -0,0 +1,64 @@ +--- +slug: /references/js-sdk/admin/fulfillment +sidebar_label: fulfillment +--- + +import { TypeList } from "docs-ui" + +# fulfillment - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.fulfillment` set of methods used to send requests to Medusa's Store API routes. + +## listCartOptions + +This method retrieves the list of shipping options for a cart. It sends a request to +the [List Shipping Options](https://docs.medusajs.com/v2/api/store#shipping-options\_getshippingoptions) +API route. + +Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping). + +### Example + +```ts +sdk.store.fulfillment.listCartOptions({ + cart_id: "cart_123" +}) +.then(({ shipping_options }) => { + console.log(shipping_options) +}) +``` + +### Parameters + + + +### Returns + + + +## listCartOptions + +This method retrieves the list of shipping options for a cart. It sends a request to +the [List Shipping Options](https://docs.medusajs.com/v2/api/store#shipping-options\_getshippingoptions) +API route. + +Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping). + +### Example + +```ts +sdk.store.fulfillment.listCartOptions({ + cart_id: "cart_123" +}) +.then(({ shipping_options }) => { + console.log(shipping_options) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx new file mode 100644 index 0000000000..5c456dd103 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx @@ -0,0 +1,194 @@ +--- +slug: /references/js-sdk/admin/order +sidebar_label: order +--- + +import { TypeList } from "docs-ui" + +# order - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.order` set of methods used to send requests to Medusa's Store API routes. + +## list + +This method retrieves a paginated list of orders matching the specified filters. It +sends a request to the [List Orders](https://docs.medusajs.com/v2/api/store#orders\_getorders) +API route. + +### Example + +To retrieve the list of orders: + +```ts +sdk.store.order.list() +.then(({ orders, count, offset, limit }) => { + console.log(orders) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.order.list({ + limit: 10, + offset: 10 +}) +.then(({ orders, count, offset, limit }) => { + console.log(orders) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each order: + +```ts +sdk.store.order.list({ + fields: "id,*items" +}) +.then(({ orders, count, offset, limit }) => { + console.log(orders) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves an order by its ID. It sends a request to the +[Get Order](https://docs.medusajs.com/v2/api/store#orders\_getordersid) API route. + +### Example + +To retrieve an order by its ID: + +```ts +sdk.store.order.retrieve("order_123") +.then(({ order }) => { + console.log(order) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.order.retrieve("order_123", { + fields: "id,*items" +}) +.then(({ order }) => { + console.log(order) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +## list + +This method retrieves a paginated list of orders matching the specified filters. It +sends a request to the [List Orders](https://docs.medusajs.com/v2/api/store#orders\_getorders) +API route. + +### Example + +To retrieve the list of orders: + +```ts +sdk.store.order.list() +.then(({ orders, count, offset, limit }) => { + console.log(orders) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.order.list({ + limit: 10, + offset: 10 +}) +.then(({ orders, count, offset, limit }) => { + console.log(orders) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each order: + +```ts +sdk.store.order.list({ + fields: "id,*items" +}) +.then(({ orders, count, offset, limit }) => { + console.log(orders) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves an order by its ID. It sends a request to the +[Get Order](https://docs.medusajs.com/v2/api/store#orders\_getordersid) API route. + +### Example + +To retrieve an order by its ID: + +```ts +sdk.store.order.retrieve("order_123") +.then(({ order }) => { + console.log(order) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.order.retrieve("order_123", { + fields: "id,*items" +}) +.then(({ order }) => { + console.log(order) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx new file mode 100644 index 0000000000..319cf4d7b0 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx @@ -0,0 +1,210 @@ +--- +slug: /references/js-sdk/admin/payment +sidebar_label: payment +--- + +import { TypeList } from "docs-ui" + +# payment - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.payment` set of methods used to send requests to Medusa's Store API routes. + +## listPaymentProviders + +This method retrieves the payment providers available in a region, which is useful during checkout. +It sends a request to the [List Payment Providers](https://docs.medusajs.com/v2/api/store#payment-providers\_getpaymentproviders) +API route. + +Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment). + +### Example + +To retrieve the list of payment providers for a region: + +```ts +sdk.store.payment.listPaymentProviders({ + region_id: "reg_123" +}) +.then(({ payment_providers, count, offset, limit }) => { + 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.store.payment.listPaymentProviders({ + region_id: "reg_123", + limit: 10, + offset: 10 +}) +.then(({ payment_providers, count, offset, limit }) => { + console.log(payment_providers) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each provider: + +```ts +sdk.store.payment.listPaymentProviders({ + region_id: "reg_123", + limit: 10, + offset: 10, + fields: "id" +}) +.then(({ payment_providers, count, offset, limit }) => { + console.log(payment_providers) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## initiatePaymentSession + +This method creates a payment session of a cart's payment collection, selecting a payment provider. +It sends a request to the [Initialize Payment Session](https://docs.medusajs.com/v2/api/store#payment-collections\_postpaymentcollectionsidpaymentsessions) +API route. + +If the cart doesn't have a payment collection, a payment collection is created for the cart by +sending a request to the [Create Payment Collection](https://docs.medusajs.com/v2/api/store#payment-collections\_postpaymentcollections) +API route. + +Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment). + +### Example + +```ts +sdk.store.payment.initiatePaymentSession( + cart, // assuming you already have the cart object. + { + provider_id: "pp_stripe_stripe", + data: { + // any data relevant for the provider. + } + } +) +.then(({ payment_collection }) => { + console.log(payment_collection) +}) +``` + +### Parameters + + + +### Returns + + + +## listPaymentProviders + +This method retrieves the payment providers available in a region, which is useful during checkout. +It sends a request to the [List Payment Providers](https://docs.medusajs.com/v2/api/store#payment-providers\_getpaymentproviders) +API route. + +Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment). + +### Example + +To retrieve the list of payment providers for a region: + +```ts +sdk.store.payment.listPaymentProviders({ + region_id: "reg_123" +}) +.then(({ payment_providers, count, offset, limit }) => { + 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.store.payment.listPaymentProviders({ + region_id: "reg_123", + limit: 10, + offset: 10 +}) +.then(({ payment_providers, count, offset, limit }) => { + console.log(payment_providers) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each provider: + +```ts +sdk.store.payment.listPaymentProviders({ + region_id: "reg_123", + limit: 10, + offset: 10, + fields: "id" +}) +.then(({ payment_providers, count, offset, limit }) => { + console.log(payment_providers) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## initiatePaymentSession + +This method creates a payment session of a cart's payment collection, selecting a payment provider. +It sends a request to the [Initialize Payment Session](https://docs.medusajs.com/v2/api/store#payment-collections\_postpaymentcollectionsidpaymentsessions) +API route. + +If the cart doesn't have a payment collection, a payment collection is created for the cart by +sending a request to the [Create Payment Collection](https://docs.medusajs.com/v2/api/store#payment-collections\_postpaymentcollections) +API route. + +Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment). + +### Example + +```ts +sdk.store.payment.initiatePaymentSession( + cart, // assuming you already have the cart object. + { + provider_id: "pp_stripe_stripe", + data: { + // any data relevant for the provider. + } + } +) +.then(({ payment_collection }) => { + console.log(payment_collection) +}) +``` + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx new file mode 100644 index 0000000000..1afe0c0059 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx @@ -0,0 +1,212 @@ +--- +slug: /references/js-sdk/admin/product +sidebar_label: product +--- + +import { TypeList } from "docs-ui" + +# product - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.product` set of methods used to send requests to Medusa's Store API routes. + +## list + +This method retrieves a list of products. It sends a request to the +[List Products API route](https://docs.medusajs.com/v2/api/store#products\_getproducts). + +Related guides: + +- [How to list products in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/list). +- [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price) + +### Example + +To retrieve the list of products: + +```ts +sdk.store.product.list() +.then(({ products, count, offset, limit }) => { + console.log(products) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.product.list({ + limit: 10, + offset: 10 +}) +.then(({ products, count, offset, limit }) => { + console.log(products) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each product: + +```ts +sdk.store.product.list({ + fields: "id,*collection" +}) +.then(({ products, count, offset, limit }) => { + console.log(products) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method is used to retrieve a product by its ID. It sends a request to the +[Get Product](https://docs.medusajs.com/v2/api/store#products\_getproductsid) API route. + +Related guides: + +- [How to retrieve a product in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/retrieve). +- [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price) + +### Example + +To retrieve a product by its ID: + +```ts +sdk.store.product.retrieve("prod_123") +.then(({ product }) => { + console.log(product) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.product.retrieve("prod_123", { + fields: "id,*collection" +}) +.then(({ product }) => { + console.log(product) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +## list + +This method retrieves a list of products. It sends a request to the +[List Products API route](https://docs.medusajs.com/v2/api/store#products\_getproducts). + +Related guides: + +- [How to list products in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/list). +- [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price) + +### Example + +To retrieve the list of products: + +```ts +sdk.store.product.list() +.then(({ products, count, offset, limit }) => { + console.log(products) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.product.list({ + limit: 10, + offset: 10 +}) +.then(({ products, count, offset, limit }) => { + console.log(products) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each product: + +```ts +sdk.store.product.list({ + fields: "id,*collection" +}) +.then(({ products, count, offset, limit }) => { + console.log(products) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method is used to retrieve a product by its ID. It sends a request to the +[Get Product](https://docs.medusajs.com/v2/api/store#products\_getproductsid) API route. + +Related guides: + +- [How to retrieve a product in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/retrieve). +- [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price) + +### Example + +To retrieve a product by its ID: + +```ts +sdk.store.product.retrieve("prod_123") +.then(({ product }) => { + console.log(product) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.product.retrieve("prod_123", { + fields: "id,*collection" +}) +.then(({ product }) => { + console.log(product) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx new file mode 100644 index 0000000000..e1138d4723 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx @@ -0,0 +1,206 @@ +--- +slug: /references/js-sdk/admin/region +sidebar_label: region +--- + +import { TypeList } from "docs-ui" + +# region - JS SDK Store Reference + +This documentation provides a reference to the `sdk.store.region` set of methods used to send requests to Medusa's Store API routes. + +## list + +This method retrieves the paginated list of regions in the store. It sends a request to the +[List Regions API route](https://docs.medusajs.com/v2/api/store#regions\_getregions). + +Related guide: [How to list regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/list). + +### Example + +To retrieve the list of regions: + +```ts +sdk.store.region.list() +.then(({ regions, count, limit, offset }) => { + console.log(regions) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.region.list({ + limit: 10, + offset: 10 +}) +.then(({ regions, count, limit, offset }) => { + console.log(regions) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each region: + +```ts +sdk.store.region.list({ + fields: "id,*countries" +}) +.then(({ regions, count, limit, offset }) => { + console.log(regions) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/v2/api/store#regions\_getregionsid) +API route. + +Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/store-retrieve-region). + +### Example + +To retrieve a region by its ID: + +```ts +sdk.store.region.retrieve("reg_123") +.then(({ region }) => { + console.log(region) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.region.retrieve( + "reg_123", + { + fields: "id,*countries" + } +) +.then(({ region }) => { + console.log(region) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +## list + +This method retrieves the paginated list of regions in the store. It sends a request to the +[List Regions API route](https://docs.medusajs.com/v2/api/store#regions\_getregions). + +Related guide: [How to list regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/list). + +### Example + +To retrieve the list of regions: + +```ts +sdk.store.region.list() +.then(({ regions, count, limit, offset }) => { + console.log(regions) +}) +``` + +To configure the pagination, pass the `limit` and `offset` query parameters. + +For example, to retrieve only 10 items and skip 10 items: + +```ts +sdk.store.region.list({ + limit: 10, + offset: 10 +}) +.then(({ regions, count, limit, offset }) => { + console.log(regions) +}) +``` + +Using the `fields` query parameter, you can specify the fields and relations to retrieve +in each region: + +```ts +sdk.store.region.list({ + fields: "id,*countries" +}) +.then(({ regions, count, limit, offset }) => { + console.log(regions) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + + +___ + +## retrieve + +This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/v2/api/store#regions\_getregionsid) +API route. + +Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/store-retrieve-region). + +### Example + +To retrieve a region by its ID: + +```ts +sdk.store.region.retrieve("reg_123") +.then(({ region }) => { + console.log(region) +}) +``` + +To specify the fields and relations to retrieve: + +```ts +sdk.store.region.retrieve( + "reg_123", + { + fields: "id,*countries" + } +) +.then(({ region }) => { + console.log(region) +}) +``` + +Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations). + +### Parameters + + + +### Returns + + diff --git a/www/apps/resources/references/js_sdk/store/classes/js_sdk.store.Store/page.mdx b/www/apps/resources/references/js_sdk/store/classes/js_sdk.store.Store/page.mdx new file mode 100644 index 0000000000..53d83354a6 --- /dev/null +++ b/www/apps/resources/references/js_sdk/store/classes/js_sdk.store.Store/page.mdx @@ -0,0 +1,21 @@ +--- +slug: /references/js-sdk/store +--- + +import { TypeList } from "docs-ui" + +# JS SDK Store Reference + +The `sdk.store` class provides methods to send requests to Medusa's Store API routes. + +## Properties + +- [region](../../Store/properties/js_sdk.store.Store.region/page.mdx) +- [collection](../../Store/properties/js_sdk.store.Store.collection/page.mdx) +- [category](../../Store/properties/js_sdk.store.Store.category/page.mdx) +- [product](../../Store/properties/js_sdk.store.Store.product/page.mdx) +- [cart](../../Store/properties/js_sdk.store.Store.cart/page.mdx) +- [fulfillment](../../Store/properties/js_sdk.store.Store.fulfillment/page.mdx) +- [payment](../../Store/properties/js_sdk.store.Store.payment/page.mdx) +- [order](../../Store/properties/js_sdk.store.Store.order/page.mdx) +- [customer](../../Store/properties/js_sdk.store.Store.customer/page.mdx) diff --git a/www/apps/resources/references/modules/js_sdk/page.mdx b/www/apps/resources/references/modules/js_sdk/page.mdx new file mode 100644 index 0000000000..ff4831e987 --- /dev/null +++ b/www/apps/resources/references/modules/js_sdk/page.mdx @@ -0,0 +1,9 @@ +import { TypeList } from "docs-ui" + +# js-sdk + +## Modules + +- [admin](../../js_sdk/modules/js_sdk.admin/page.mdx) +- [auth](../../js_sdk/modules/js_sdk.auth/page.mdx) +- [store](../../js_sdk/modules/js_sdk.store/page.mdx) diff --git a/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx b/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx index 6b01833a7b..790cb48761 100644 --- a/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx +++ b/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminClaimOrderResponse/page.mdx @@ -4,4 +4,4 @@ import { TypeList } from "docs-ui" ## Properties -`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refundable_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw refundable total of the order line item..","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refundable_total_per_unit","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordered_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The ordered total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The fulfilled total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The returned total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_request_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The return request total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"write_off_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The write off total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"projected_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The projected total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The balance of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The paid total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refunded total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pending_difference","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_pending_difference","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim","type":"[AdminClaim](../types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../order/types/order.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_items","type":"[BaseClaimItem](../../../interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../order/types/order.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminClaimOrderResponse"/> +`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordered_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The ordered total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The fulfilled total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The returned total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_request_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The return request total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"write_off_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The write off total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"projected_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The projected total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The balance of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The paid total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refunded total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pending_difference","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim","type":"[AdminClaim](../types.HttpTypes.AdminClaim/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`AdminOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseClaimItem](../../../interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../order/types/order.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_items","type":"[BaseClaimItem](../../../interfaces/types.BaseClaimItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../../order/types/order.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"`AdminOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminClaimOrderResponse"/> diff --git a/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse/page.mdx b/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse/page.mdx index 14c640cd32..fe4370f0fd 100644 --- a/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse/page.mdx +++ b/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminExchangeOrderResponse/page.mdx @@ -4,4 +4,4 @@ import { TypeList } from "docs-ui" ## Properties -`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refundable_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw refundable total of the order line item..","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refundable_total_per_unit","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordered_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The ordered total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The fulfilled total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The returned total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_request_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The return request total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"write_off_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The write off total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"projected_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The projected total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The balance of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The paid total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refunded total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pending_difference","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_pending_difference","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"exchange","type":"[AdminExchange](../types.HttpTypes.AdminExchange/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseExchangeItem](../../../interfaces/types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`BaseOrder`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`BaseOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminExchangeOrderResponse"/> +`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordered_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The ordered total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The fulfilled total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The returned total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_request_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The return request total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"write_off_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The write off total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"projected_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The projected total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The balance of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The paid total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refunded total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pending_difference","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"exchange","type":"[AdminExchange](../types.HttpTypes.AdminExchange/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[BaseExchangeItem](../../../interfaces/types.BaseExchangeItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`BaseOrder`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"`BaseOrderShippingMethod`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactions","type":"`BaseOrderTransaction`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminExchangeOrderResponse"/> diff --git a/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderReturnResponse/page.mdx b/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderReturnResponse/page.mdx index 03b267a8cd..ace4e2c185 100644 --- a/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderReturnResponse/page.mdx +++ b/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminOrderReturnResponse/page.mdx @@ -4,4 +4,4 @@ import { TypeList } from "docs-ui" ## Properties -`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_item_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refundable_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw refundable total of the order line item..","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_refundable_total_per_unit","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_unit_price","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_compare_at_unit_price","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_original_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_subtotal","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_tax_total","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordered_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The ordered total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The fulfilled total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The returned total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_request_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The return request total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"write_off_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The write off total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"projected_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The projected total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The balance of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The paid total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refunded total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pending_difference","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_pending_difference","type":"[BigNumberRawValue](../../../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)","description":"The raw pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminOrderReturnResponse"/> +`","description":"The metadata of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was declined","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`null` \\| `string`","description":"The canceled by of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `string` \\| `Date`","description":"When the order change was canceled","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order change was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order change was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"change_type","type":"`\"return\"` \\| `\"exchange\"` \\| `\"claim\"` \\| `\"edit\"`","description":"The type of the order change","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"[OrderAddressDTO](../../../../fulfillment/interfaces/fulfillment.OrderAddressDTO/page.mdx)","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the address was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the address was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The phone number of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"The company of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"The second address line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The country code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"The province/state of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[OrderLineItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemDTO/page.mdx)[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_total_per_unit","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refundable total per unit of the order line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Indicates whether the line item requires shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_discountable","type":"`boolean`","description":"Indicates whether the line item is discountable.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Indicates whether the line item price is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The unit price of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"[OrderItemDTO](../../../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)","description":"The details of the item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date when the line item was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date when the line item was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"The subtitle of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"The thumbnail of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The ID of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The ID of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_title","type":"`null` \\| `string`","description":"The title of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_description","type":"`null` \\| `string`","description":"The description of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_subtitle","type":"`null` \\| `string`","description":"The subtitle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"`null` \\| `string`","description":"The type of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"`null` \\| `string`","description":"The collection of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_handle","type":"`null` \\| `string`","description":"The handle of the product associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_sku","type":"`null` \\| `string`","description":"The SKU (stock keeping unit) of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_barcode","type":"`null` \\| `string`","description":"The barcode of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_title","type":"`null` \\| `string`","description":"The title of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_option_values","type":"`null` \\| `Record`","description":"The option values of the variant associated with the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compare_at_unit_price","type":"`number`","description":"The compare at unit price of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderLineItemTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderLineItemAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderLineItemAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_methods","type":"[OrderShippingMethodDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodDTO/page.mdx)[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The price of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`boolean`","description":"Whether the shipping method price is tax inclusive or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the shipping method was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the shipping method was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The discount tax total of the order shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option the method was created from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data needed for fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[OrderShippingMethodTaxLineDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodTaxLineDTO/page.mdx)[]","description":"The associated tax lines.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[OrderShippingMethodAdjustmentDTO](../../../../fulfillment/interfaces/fulfillment.OrderShippingMethodAdjustmentDTO/page.mdx)[]","description":"The associated adjustments.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"transactions","type":"[OrderTransactionDTO](../../../../fulfillment/interfaces/fulfillment.OrderTransactionDTO/page.mdx)[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../../../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The amount of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The reference of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the reference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the transaction was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the transaction was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"The metadata of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"summary","type":"[OrderSummaryDTO](../../../../fulfillment/interfaces/fulfillment.OrderSummaryDTO/page.mdx)","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ordered_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The ordered total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The fulfilled total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The returned total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_request_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The return request total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"write_off_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The write off total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"projected_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The projected total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_subtotal","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net subtotal of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"net_total_tax","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The net total tax of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The balance of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paid_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The paid total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The refunded total of the order summary.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pending_difference","type":"[BigNumberValue](../../../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)","description":"The pending difference of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return","type":"[AdminReturn](../types.HttpTypes.AdminReturn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[AdminReturnItem](../types.HttpTypes.AdminReturnItem/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"damaged_quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../../../order/types/order.ReturnStatus-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AdminOrderReturnResponse"/> diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs index 83ccbe87e2..bc79f30dd6 100644 --- a/www/apps/resources/sidebar.mjs +++ b/www/apps/resources/sidebar.mjs @@ -2049,6 +2049,28 @@ export const sidebar = sidebarAttachHrefCommonOptions([ type: "link", path: "/js-sdk", title: "JS SDK", + isChildSidebar: true, + childSidebarTitle: "JS SDK Reference", + children: [ + { + type: "category", + title: "Auth", + autogenerate_path: "/references/js_sdk/auth/Auth/methods", + initialOpen: true, + }, + { + type: "category", + title: "Store", + autogenerate_path: "/references/js_sdk/store/Store/properties", + initialOpen: true, + }, + { + type: "category", + title: "Admin", + autogenerate_path: "/references/js_sdk/admin/Admin/properties", + initialOpen: true, + }, + ], }, { type: "link", diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx index fc73fe7c14..d3abd63c26 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx @@ -28,6 +28,7 @@ export const SidebarItemCategory = ({ updatePersistedCategoryState, getPersistedCategoryState, persistState, + activePath, } = useSidebar() const itemShowLoading = useMemo(() => { return !item.loaded || (item.showLoadingIfEmpty && !item.children?.length) @@ -47,6 +48,7 @@ export const SidebarItemCategory = ({ useEffect(() => { const isActive = isChildrenActive(item) + if (isActive && !open) { setOpen(true) } diff --git a/www/packages/docs-ui/src/components/Sidebar/index.tsx b/www/packages/docs-ui/src/components/Sidebar/index.tsx index e90978df0a..21aeff475c 100644 --- a/www/packages/docs-ui/src/components/Sidebar/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/index.tsx @@ -1,6 +1,6 @@ "use client" -import React, { useMemo, useRef } from "react" +import React, { Suspense, useMemo, useRef } from "react" import { useSidebar } from "@/providers" import clsx from "clsx" import { Loading } from "@/components" @@ -142,12 +142,24 @@ export const Sidebar = ({ ? `${item.path}-${index}` : `${item.title}-${index}` return ( - + } key={itemKey} - expandItems={expandItems} - hasNextItems={index !== sidebarItems.default.length - 1} - /> + > + + ) })} diff --git a/www/utils/generated/typedoc-json-output/js-sdk.json b/www/utils/generated/typedoc-json-output/js-sdk.json new file mode 100644 index 0000000000..f443c44658 --- /dev/null +++ b/www/utils/generated/typedoc-json-output/js-sdk.json @@ -0,0 +1,50396 @@ +{ + "id": 0, + "name": "js-sdk", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "admin", + "variant": "declaration", + "kind": 2, + "flags": {}, + "children": [ + { + "id": 1740, + "name": "ApiKey", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1744, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1741, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1742, + "name": "new ApiKey", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1743, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1740, + "name": "ApiKey", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1745, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1746, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This methods retrieves a paginated list of API keys. It sends a request to the \n[List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of API keys." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of API keys:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.list()\n.then(({ api_keys, count, limit, offset }) => {\n console.log(api_keys)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.list({\n limit: 10,\n offset: 10\n})\n.then(({ api_keys, count, limit, offset }) => {\n console.log(api_keys)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each API key:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.list({\n fields: \"id,*sales_channels\"\n})\n.then(({ api_keys, count, limit, offset }) => {\n console.log(api_keys)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1747, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/queries.ts", + "qualifiedName": "AdminGetApiKeysParams" + }, + "name": "AdminGetApiKeysParams", + "package": "@medusajs/types" + } + }, + { + "id": 1748, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyListResponse" + }, + "name": "AdminApiKeyListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1749, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1750, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The created API key" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.create({\n title: \"Development\",\n type: \"publishable\"\n})\n.then(({ api_key }) => {\n console.log(api_key)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1751, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API key's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/payloads.ts", + "qualifiedName": "AdminCreateApiKey" + }, + "name": "AdminCreateApiKey", + "package": "@medusajs/types" + } + }, + { + "id": 1752, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the created API key." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/queries.ts", + "qualifiedName": "AdminGetApiKeysParams" + }, + "name": "AdminGetApiKeysParams", + "package": "@medusajs/types" + } + }, + { + "id": 1753, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyResponse" + }, + "name": "AdminApiKeyResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1754, + "name": "revoke", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1755, + "name": "revoke", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method revokes an API key. It sends a request to the \n[Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The API key's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.revoke(\"apk_123\")\n.then(({ api_key }) => {\n console.log(api_key)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1756, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1757, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyResponse" + }, + "name": "AdminApiKeyResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1758, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1759, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves an API key's details. It sends a request to the \n[Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The API key's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.retrieve(\"apk_123\")\n.then(({ api_key }) => {\n console.log(api_key)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1760, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1761, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyResponse" + }, + "name": "AdminApiKeyResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1762, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1763, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates an API key's details. It sends a request to the \n[Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The API key's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.update(\"apk_123\", {\n title: \"Development\"\n})\n.then(({ api_key }) => {\n console.log(api_key)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1764, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1765, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in the API key." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/payloads.ts", + "qualifiedName": "AdminUpdateApiKey" + }, + "name": "AdminUpdateApiKey", + "package": "@medusajs/types" + } + }, + { + "id": 1766, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the API key." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/queries.ts", + "qualifiedName": "AdminGetApiKeysParams" + }, + "name": "AdminGetApiKeysParams", + "package": "@medusajs/types" + } + }, + { + "id": 1767, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyResponse" + }, + "name": "AdminApiKeyResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1768, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1769, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes an API key by its ID. It sends a request to the \n[Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The deletion's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.delete(\"apk_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1770, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1771, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyDeleteResponse" + }, + "name": "AdminApiKeyDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1772, + "name": "batchSalesChannels", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1773, + "name": "batchSalesChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method manages the sales channels associated with a publishable API key to either add\nor remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The API key's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.apiKey.batchSalesChannels(\"apk_123\", {\n add: [\"sc_123\"],\n remove: [\"sc_321\"]\n})\n.then(({ api_key }) => {\n console.log(api_key)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1774, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API key's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1775, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channels to add or remove from the API key." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "AdminBatchLink" + }, + "name": "AdminBatchLink", + "package": "@medusajs/types" + } + }, + { + "id": 1776, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/api-key/admin/responses.ts", + "qualifiedName": "AdminApiKeyResponse" + }, + "name": "AdminApiKeyResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1741 + ] + }, + { + "title": "Properties", + "children": [ + 1744 + ] + }, + { + "title": "Methods", + "children": [ + 1745, + 1749, + 1754, + 1758, + 1762, + 1768, + 1772 + ] + } + ] + }, + { + "id": 1915, + "name": "Campaign", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1919, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1916, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1917, + "name": "new Campaign", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1918, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1915, + "name": "Campaign", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1920, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1921, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a campaign by its ID. It sends a request to the \n[Get Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaignsid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The campaign's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a campaign by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.retrieve(\"procamp_123\")\n.then(({ campaign }) => {\n console.log(campaign)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.retrieve(\"procamp_123\", {\n fields: \"id,*budget\"\n})\n.then(({ campaign }) => {\n console.log(campaign)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1922, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The campaign's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1923, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the campaign." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/queries.ts", + "qualifiedName": "AdminGetCampaignParams" + }, + "name": "AdminGetCampaignParams", + "package": "@medusajs/types" + } + }, + { + "id": 1924, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/responses.ts", + "qualifiedName": "AdminCampaignResponse" + }, + "name": "AdminCampaignResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1925, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1926, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of campaigns. It sends a request to the \n[List Campaigns](https://docs.medusajs.com/v2/api/admin#campaigns_getcampaigns) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of campaigns." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of campaigns:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.list()\n.then(({ campaigns, count, limit, offset }) => {\n console.log(campaigns)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.list({\n limit: 10,\n offset: 10\n})\n.then(({ campaigns, count, limit, offset }) => {\n console.log(campaigns)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each campaign:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.list({\n fields: \"id,*budget\"\n})\n.then(({ campaigns, count, limit, offset }) => {\n console.log(campaigns)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1927, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/queries.ts", + "qualifiedName": "AdminGetCampaignsParams" + }, + "name": "AdminGetCampaignsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1928, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/responses.ts", + "qualifiedName": "AdminCampaignListResponse" + }, + "name": "AdminCampaignListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1929, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1930, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates a campaign. It sends a request to the \n[Create Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaigns) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The campaign's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.create({\n name: \"Summer Campaign\"\n})\n.then(({ campaign }) => {\n console.log(campaign)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1931, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the campaign to create." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/payloads.ts", + "qualifiedName": "AdminCreateCampaign" + }, + "name": "AdminCreateCampaign", + "package": "@medusajs/types" + } + }, + { + "id": 1932, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/responses.ts", + "qualifiedName": "AdminCampaignResponse" + }, + "name": "AdminCampaignResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1933, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1934, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a campaign. It sends a request to the \n[Update Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The campaign's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.update(\"procamp_123\", {\n name: \"Summer Campaign\"\n})\n.then(({ campaign }) => {\n console.log(campaign)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1935, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The campaign's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1936, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in the campaign." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/payloads.ts", + "qualifiedName": "AdminUpdateCampaign" + }, + "name": "AdminUpdateCampaign", + "package": "@medusajs/types" + } + }, + { + "id": 1937, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/responses.ts", + "qualifiedName": "AdminCampaignResponse" + }, + "name": "AdminCampaignResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1938, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1939, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes a campaign by its ID. It sends a request to the\n[Delete Campaign](https://docs.medusajs.com/v2/api/admin#campaigns_deletecampaignsid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The deletion's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.campaign.delete(\"procamp_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1940, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The campaign's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1941, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "DeleteResponse" + }, + "typeArguments": [ + { + "type": "literal", + "value": "campaign" + } + ], + "name": "DeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1942, + "name": "batchPromotions", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1943, + "name": "batchPromotions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method manages the promotions of a campaign to either add or remove the association between them.\nIt sends a request to the [Manage Promotions](https://docs.medusajs.com/v2/api/admin#campaigns_postcampaignsidpromotions)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The campaign's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1944, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The campaign's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1945, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The promotions to add or remove associations to them." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "AdminBatchLink" + }, + "name": "AdminBatchLink", + "package": "@medusajs/types" + } + }, + { + "id": 1946, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/campaign/admin/responses.ts", + "qualifiedName": "AdminCampaignResponse" + }, + "name": "AdminCampaignResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1916 + ] + }, + { + "title": "Properties", + "children": [ + 1919 + ] + }, + { + "title": "Methods", + "children": [ + 1920, + 1925, + 1929, + 1933, + 1938, + 1942 + ] + } + ] + }, + { + "id": 1274, + "name": "Claim", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1278, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1275, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1276, + "name": "new Claim", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1277, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1274, + "name": "Claim", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1279, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1280, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of claims. It sends a request to the \n[List Claims](https://docs.medusajs.com/v2/api/admin#claims_getclaims) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of claims." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of claims:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.list()\n.then(({ claims, count, limit, offset }) => {\n console.log(claims)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.list({\n limit: 10,\n offset: 10\n})\n.then(({ claims, count, limit, offset }) => {\n console.log(claims)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each claim:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.list({\n fields: \"id,*additional_items\"\n})\n.then(({ claims, count, limit, offset }) => {\n console.log(claims)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1281, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/queries.ts", + "qualifiedName": "AdminClaimListParams" + }, + "name": "AdminClaimListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1282, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimListResponse" + }, + "name": "AdminClaimListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1283, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1284, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a claim. It sends a request to the\n[Get Claim](https://docs.medusajs.com/v2/api/admin#claims_getclaimsid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The claim's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a claim by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.retrieve(\"claim_123\")\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.retrieve(\"claim_123\", {\n fields: \"id,*additional_items\"\n})\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1285, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1286, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1287, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimResponse" + }, + "name": "AdminClaimResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1288, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1289, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates a claim. It sends a request to the \n[Create Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaims) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The claim and order's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.create({\n type: \"refund\",\n order_id: \"order_123\",\n})\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1290, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminCreateClaim" + }, + "name": "AdminCreateClaim", + "package": "@medusajs/types" + } + }, + { + "id": 1291, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1292, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimOrderResponse" + }, + "name": "AdminClaimOrderResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1293, + "name": "cancel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1294, + "name": "cancel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method cancels a claim. It sends a request to the\n[Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidcancel) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The claim's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.cancel(\"claim_123\")\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1295, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1296, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1297, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimResponse" + }, + "name": "AdminClaimResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1298, + "name": "addItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1299, + "name": "addItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds items to the claim. It sends a request to the\n[Add Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitems) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The claim's details with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.addItems(\"claim_123\", {\n items: [\n {\n id: \"orli_123\",\n quantity: 1\n }\n ]\n})\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1300, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the claim to add the items to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1301, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items' details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminAddClaimItems" + }, + "name": "AdminAddClaimItems", + "package": "@medusajs/types" + } + }, + { + "id": 1302, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1303, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1304, + "name": "updateItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1305, + "name": "updateItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a claim item by the ID of the item's " + }, + { + "kind": "code", + "text": "`WRITE_OFF_ITEM`" + }, + { + "kind": "text", + "text": " action. It\nsends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitemsaction_id) API route.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The claim's details with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.updateItem(\n \"claim_123\", \n \"ordchact_123\",\n {\n quantity: 1\n }\n )\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1306, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1307, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the order item's " + }, + { + "kind": "code", + "text": "`WRITE_OFF_ITEM`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1308, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminUpdateClaimItem" + }, + "name": "AdminUpdateClaimItem", + "package": "@medusajs/types" + } + }, + { + "id": 1309, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1310, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1311, + "name": "removeItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1312, + "name": "removeItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes a claim item from a claim by the ID of the item's " + }, + { + "kind": "code", + "text": "`WRITE_OFF_ITEM`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidclaimitemsaction_id)\nAPI route.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The claim's details with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.removeItem(\n \"claim_123\", \n \"ordchact_123\",\n )\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1313, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1314, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the order item's " + }, + { + "kind": "code", + "text": "`WRITE_OFF_ITEM`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1315, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1316, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1317, + "name": "addInboundItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1318, + "name": "addInboundItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds inbound (or return) items to the claim. These inbound items will have a " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action.\n\nThis method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditems)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.addInboundItems(\n \"claim_123\", \n {\n items: [\n {\n id: \"orli_123\",\n quantity: 1\n }\n ]\n },\n )\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1319, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the claim to add the inbound items to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1320, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inbound items' details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminAddClaimInboundItems" + }, + "name": "AdminAddClaimInboundItems", + "package": "@medusajs/types" + } + }, + { + "id": 1321, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1322, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimReturnPreviewResponse" + }, + "name": "AdminClaimReturnPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1323, + "name": "updateInboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1324, + "name": "updateInboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates an inbound (or return) item of a claim using the ID of the item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditemsaction_id)\nAPI route.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated wth the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.updateInboundItem(\n \"claim_123\", \n \"ordchact_123\",\n {\n quantity: 1\n },\n )\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1325, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1326, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the return item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1327, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the inbound item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminUpdateClaimInboundItem" + }, + "name": "AdminUpdateClaimInboundItem", + "package": "@medusajs/types" + } + }, + { + "id": 1328, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1329, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimReturnPreviewResponse" + }, + "name": "AdminClaimReturnPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1330, + "name": "removeInboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1331, + "name": "removeInboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes an inbound (or return) item from a claim using the ID of the item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinbounditemsaction_id)\nAPI route.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated wth the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.removeInboundItem(\n \"claim_123\", \n \"ordchact_123\",\n )\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1332, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1333, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the return item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1334, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1335, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimReturnPreviewResponse" + }, + "name": "AdminClaimReturnPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1336, + "name": "addInboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1337, + "name": "addInboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds an inbound (or return) shipping method to a claim. \nThe inbound shipping method will have a " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nThis method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethod)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated wth the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.addInboundShipping(\n \"claim_123\", \n {\n shipping_option_id: \"so_123\",\n custom_amount: 10\n },\n )\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1338, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1339, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminClaimAddInboundShipping" + }, + "name": "AdminClaimAddInboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1340, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1341, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimReturnPreviewResponse" + }, + "name": "AdminClaimReturnPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1342, + "name": "updateInboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1343, + "name": "updateInboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a shipping method for returning items in the claim using the ID of the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethodaction_id)\nAPI route.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.updateInboundShipping(\n \"claim_123\", \n \"ordchact_123\",\n {\n custom_amount: 10\n },\n )\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1344, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1345, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1346, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the shipping method" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminClaimUpdateInboundShipping" + }, + "name": "AdminClaimUpdateInboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1347, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1348, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1349, + "name": "deleteInboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1350, + "name": "deleteInboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes a shipping method for returning items in the claim using the ID of the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)\nAPI route.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated wth the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.deleteInboundShipping(\n \"claim_123\", \n \"ordchact_123\",\n )\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1351, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1352, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1353, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1354, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimReturnPreviewResponse" + }, + "name": "AdminClaimReturnPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1355, + "name": "addOutboundItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1356, + "name": "addOutboundItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds outbound (or new) items to a claim. These outbound items will have an " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditems)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.addOutboundItems(\n \"claim_123\", \n {\n items: [{\n id: \"orli_123\",\n quantity: 1\n }]\n },\n )\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1357, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the claim to add the outbound items to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1358, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items' details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminAddClaimOutboundItems" + }, + "name": "AdminAddClaimOutboundItems", + "package": "@medusajs/types" + } + }, + { + "id": 1359, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1360, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1361, + "name": "updateOutboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1362, + "name": "updateOutboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates an outbound (or new) item of a claim using the ID of the item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditemsaction_id)\nAPI route.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.updateOutboundItem(\n \"claim_123\", \n \"ordchact_123\",\n {\n quantity: 1\n },\n )\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1363, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1364, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the new claim item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1365, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The item's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminUpdateClaimOutboundItem" + }, + "name": "AdminUpdateClaimOutboundItem", + "package": "@medusajs/types" + } + }, + { + "id": 1366, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1367, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1368, + "name": "removeOutboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1369, + "name": "removeOutboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes an outbound (or new) item from a claim using the ID of the item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidoutbounditemsaction_id)\nAPI route.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.removeOutboundItem(\n \"claim_123\", \n \"ordchact_123\",\n)\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1370, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1371, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the new claim item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1372, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1373, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1374, + "name": "addOutboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1375, + "name": "addOutboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds outbound an outbound shipping method to a claim. \nThe outbound shipping method will have a " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nThis method sends a request to the \n[Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethod)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n* sdk.admin.claim.addOutboundShipping(\n \"claim_123\", \n {\n shipping_option_id: \"so_123\",\n custom_amount: 10\n },\n)\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1376, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1377, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminClaimAddOutboundShipping" + }, + "name": "AdminClaimAddOutboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1378, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1379, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1380, + "name": "updateOutboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1381, + "name": "updateOutboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates the shipping method for delivering outbound items in a claim using the ID of the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\nIt sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)\nAPI route.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.updateOutboundShipping(\n \"claim_123\", \n \"ordchact_123\",\n {\n custom_amount: 10\n },\n)\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1382, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1383, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1384, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminClaimUpdateOutboundShipping" + }, + "name": "AdminClaimUpdateOutboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1385, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1386, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1387, + "name": "deleteOutboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1388, + "name": "deleteOutboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes the shipping method for delivering outbound items in the claim using the ID of the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.deleteOutboundShipping(\n \"claim_123\", \n \"ordchact_123\",\n)\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1389, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1390, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1391, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1392, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimPreviewResponse" + }, + "name": "AdminClaimPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1393, + "name": "request", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1394, + "name": "request", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method confirms a claim request, applying its changes on the associated order.\nIt sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidrequest)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the claim and its associated return, with a preview of the order when the claim is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.request(\n \"claim_123\", \n {},\n)\n.then(({ claim }) => {\n console.log(claim)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1395, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1396, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The confirmation details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/payloads.ts", + "qualifiedName": "AdminRequestClaim" + }, + "name": "AdminRequestClaim", + "package": "@medusajs/types" + } + }, + { + "id": 1397, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1398, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimRequestResponse" + }, + "name": "AdminClaimRequestResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1399, + "name": "cancelRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1400, + "name": "cancelRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method cancels a requested claim. It sends a request to the\n[Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidrequest)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The cancelation's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.claim.cancelRequest(\n \"claim_123\", \n)\n.then(({ deleted }) => {\n console.log(deleted)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1401, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1402, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1403, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/claim/admin/responses.ts", + "qualifiedName": "AdminClaimDeleteResponse" + }, + "name": "AdminClaimDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1275 + ] + }, + { + "title": "Properties", + "children": [ + 1278 + ] + }, + { + "title": "Methods", + "children": [ + 1279, + 1283, + 1288, + 1293, + 1298, + 1304, + 1311, + 1317, + 1323, + 1330, + 1336, + 1342, + 1349, + 1355, + 1361, + 1368, + 1374, + 1380, + 1387, + 1393, + 1399 + ] + } + ] + }, + { + "id": 1649, + "name": "Currency", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1653, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1650, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1651, + "name": "new Currency", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1652, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1649, + "name": "Currency", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1654, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1655, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of currencies. It sends a request to the\n[List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of currencies." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of currencies:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.currency.list()\n.then(({ currencies, count, limit, offset }) => {\n console.log(currencies)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.currency.list({\n limit: 10,\n offset: 10\n})\n.then(({ currencies, count, limit, offset }) => {\n console.log(currencies)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each currency:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.currency.list({\n fields: \"code,symbol\"\n})\n.then(({ currencies, count, limit, offset }) => {\n console.log(currencies)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1656, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/currency/admin/queries.ts", + "qualifiedName": "AdminCurrencyListParams" + }, + "name": "AdminCurrencyListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1657, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/currency/admin/responses.ts", + "qualifiedName": "AdminCurrencyListResponse" + }, + "name": "AdminCurrencyListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1658, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1659, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a currency by its code. It sends a request to the\n[Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The currency's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a currency by its code:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.currency.retrieve(\"usd\")\n.then(({ currency }) => {\n console.log(currency)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.currency.retrieve(\"usd\", {\n fields: \"code,symbol\"\n})\n.then(({ currency }) => {\n console.log(currency)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1660, + "name": "code", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency's code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1661, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the currency." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/currency/admin/queries.ts", + "qualifiedName": "AdminCurrencyParams" + }, + "name": "AdminCurrencyParams", + "package": "@medusajs/types" + } + }, + { + "id": 1662, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/currency/admin/responses.ts", + "qualifiedName": "AdminCurrencyResponse" + }, + "name": "AdminCurrencyResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1650 + ] + }, + { + "title": "Properties", + "children": [ + 1653 + ] + }, + { + "title": "Methods", + "children": [ + 1654, + 1658 + ] + } + ] + }, + { + "id": 1819, + "name": "CustomerGroup", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1823, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1820, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1821, + "name": "new CustomerGroup", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1822, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1819, + "name": "CustomerGroup", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1824, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1825, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a customer group by its ID. It sends a request to the\n[Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The group's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a customer group by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.retrieve(\"cusgroup_123\")\n.then(({ customer_group }) => {\n console.log(customer_group)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.retrieve(\"cusgroup_123\", {\n fields: \"id,*customer\"\n})\n.then(({ customer_group }) => {\n console.log(customer_group)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1826, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1827, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer group." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/queries.ts", + "qualifiedName": "AdminGetCustomerGroupParams" + }, + "name": "AdminGetCustomerGroupParams", + "package": "@medusajs/types" + } + }, + { + "id": 1828, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/responses.ts", + "qualifiedName": "AdminCustomerGroupResponse" + }, + "name": "AdminCustomerGroupResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1829, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1830, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of customer groups. It sends a request to the\n[List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of customer groups." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of customer groups:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.list()\n.then(({ customer_groups, count, limit, offset }) => {\n console.log(customer_groups)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.list({\n limit: 10,\n offset: 10\n})\n.then(({ customer_groups, count, limit, offset }) => {\n console.log(customer_groups)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each customer group:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.list({\n fields: \"id,*customer\"\n})\n.then(({ customer_groups, count, limit, offset }) => {\n console.log(customer_groups)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1831, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/queries.ts", + "qualifiedName": "AdminGetCustomerGroupsParams" + }, + "name": "AdminGetCustomerGroupsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1832, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/responses.ts", + "qualifiedName": "AdminCustomerGroupListResponse" + }, + "name": "AdminCustomerGroupListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1833, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1834, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates a customer group. It sends a request to the\n[Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer group's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.create({\n name: \"VIP\"\n})\n.then(({ customer_group }) => {\n console.log(customer_group)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1835, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/payloads.ts", + "qualifiedName": "AdminCreateCustomerGroup" + }, + "name": "AdminCreateCustomerGroup", + "package": "@medusajs/types" + } + }, + { + "id": 1836, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer group." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/queries.ts", + "qualifiedName": "AdminGetCustomerGroupParams" + }, + "name": "AdminGetCustomerGroupParams", + "package": "@medusajs/types" + } + }, + { + "id": 1837, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/responses.ts", + "qualifiedName": "AdminCustomerGroupResponse" + }, + "name": "AdminCustomerGroupResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1838, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1839, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a customer group's details. It sends a request to the\n[Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer group's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.update(\"cusgroup_123\", {\n name: \"VIP\"\n})\n.then(({ customer_group }) => {\n console.log(customer_group)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1840, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1841, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the group." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/payloads.ts", + "qualifiedName": "AdminUpdateCustomerGroup" + }, + "name": "AdminUpdateCustomerGroup", + "package": "@medusajs/types" + } + }, + { + "id": 1842, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer group." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/queries.ts", + "qualifiedName": "AdminGetCustomerGroupParams" + }, + "name": "AdminGetCustomerGroupParams", + "package": "@medusajs/types" + } + }, + { + "id": 1843, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/responses.ts", + "qualifiedName": "AdminCustomerGroupResponse" + }, + "name": "AdminCustomerGroupResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1844, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1845, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes a customer group. This method sends a request to the\n[Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The deletion's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.delete(\"cusgroup_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1846, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1847, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/responses.ts", + "qualifiedName": "AdminCustomerGroupDeleteResponse" + }, + "name": "AdminCustomerGroupDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1848, + "name": "batchCustomers", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1849, + "name": "batchCustomers", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method manages customers of a group to add or remove them from the group.\nIt sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer group's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customerGroup.batchCustomers(\"cusgroup_123\", {\n add: [\"cus_123\"],\n remove: [\"cus_321\"]\n})\n.then(({ customer_group }) => {\n console.log(customer_group)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1850, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The group's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1851, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customers to add or remove from the group." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "AdminBatchLink" + }, + "name": "AdminBatchLink", + "package": "@medusajs/types" + } + }, + { + "id": 1852, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer-group/admin/responses.ts", + "qualifiedName": "AdminCustomerGroupResponse" + }, + "name": "AdminCustomerGroupResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1820 + ] + }, + { + "title": "Properties", + "children": [ + 1823 + ] + }, + { + "title": "Methods", + "children": [ + 1824, + 1829, + 1833, + 1838, + 1844, + 1848 + ] + } + ] + }, + { + "id": 332, + "name": "Customer", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 336, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 333, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 334, + "name": "new Customer", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 335, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 332, + "name": "Customer", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 337, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 338, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates a customer. It sends a request to the\n[Create Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomers) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.create({\n email: \"customer@gmail.com\"\n})\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 339, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/payloads.ts", + "qualifiedName": "AdminCreateCustomer" + }, + "name": "AdminCreateCustomer", + "package": "@medusajs/types" + } + }, + { + "id": 340, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 341, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/responses.ts", + "qualifiedName": "AdminCustomerResponse" + }, + "name": "AdminCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 342, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 343, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a customer's details. It sends a request to the\n[Update Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomersid) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.update(\"cus_123\", {\n first_name: \"John\"\n})\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 344, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 345, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/payloads.ts", + "qualifiedName": "AdminUpdateCustomer" + }, + "name": "AdminUpdateCustomer", + "package": "@medusajs/types" + } + }, + { + "id": 346, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 347, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/responses.ts", + "qualifiedName": "AdminCustomerResponse" + }, + "name": "AdminCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 348, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 349, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of customers. It sends a request to the\n[List Customers](https://docs.medusajs.com/v2/api/admin#customers_getcustomers)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of customers." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of customers:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.list()\n.then(({ customers, count, limit, offset }) => {\n console.log(customers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.list({\n limit: 10,\n offset: 10\n})\n.then(({ customers, count, limit, offset }) => {\n console.log(customers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each customer:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.list({\n fields: \"id,*groups\"\n})\n.then(({ customers, count, limit, offset }) => {\n console.log(customers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 350, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/queries.ts", + "qualifiedName": "AdminCustomerFilters" + }, + "name": "AdminCustomerFilters", + "package": "@medusajs/types" + } + }, + { + "id": 351, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/responses.ts", + "qualifiedName": "AdminCustomerListResponse" + }, + "name": "AdminCustomerListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 352, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 353, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a customer by its ID. It sends a request to the \n[Get Customer](https://docs.medusajs.com/v2/api/admin#customers_getcustomersid)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a customer by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.retrieve(\"cus_123\")\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.retrieve(\"cus_123\", {\n fields: \"id,*groups\"\n})\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 354, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 355, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 356, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/responses.ts", + "qualifiedName": "AdminCustomerResponse" + }, + "name": "AdminCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 357, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 358, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes a customer by its ID. It sends a request to the \n[Delete Customer](https://docs.medusajs.com/v2/api/admin#customers_deletecustomersid)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The deletion's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.customer.delete(\"cus_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 359, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 360, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/admin/responses.ts", + "qualifiedName": "AdminCustomerDeleteResponse" + }, + "name": "AdminCustomerDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 333 + ] + }, + { + "title": "Properties", + "children": [ + 336 + ] + }, + { + "title": "Methods", + "children": [ + 337, + 342, + 348, + 352, + 357 + ] + } + ] + }, + { + "id": 1404, + "name": "Exchange", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1408, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1405, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1406, + "name": "new Exchange", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1407, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1404, + "name": "Exchange", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1409, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1410, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of exchanges. It sends a request to the\n[List Exchanges](https://docs.medusajs.com/v2/api/admin#exchanges_getexchanges)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of exchanges." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of exchanges:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.list()\n.then(({ exchanges, count, limit, offset }) => {\n console.log(exchanges)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.list({\n limit: 10,\n offset: 10\n})\n.then(({ exchanges, count, limit, offset }) => {\n console.log(exchanges)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each exchange:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.list({\n fields: \"id,*order\"\n})\n.then(({ exchanges, count, limit, offset }) => {\n console.log(exchanges)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1411, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/queries.ts", + "qualifiedName": "AdminExchangeListParams" + }, + "name": "AdminExchangeListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1412, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeListResponse" + }, + "name": "AdminExchangeListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1413, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1414, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves an exchange by its ID. It sends a request to the \n[Get Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_getexchangesid)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve an exchange by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.retrieve(\"exchange_123\")\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.retrieve(\"exchange_123\", {\n fields: \"id,*order\"\n})\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 1415, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1416, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1417, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeResponse" + }, + "name": "AdminExchangeResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1418, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1419, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates an admin exchange. It sends a request to the\n[Create Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchanges) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.create({\n order_id: \"order_123\"\n})\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1420, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminCreateExchange" + }, + "name": "AdminCreateExchange", + "package": "@medusajs/types" + } + }, + { + "id": 1421, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1422, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeResponse" + }, + "name": "AdminExchangeResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1423, + "name": "cancel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1424, + "name": "cancel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method cancels an exchange. It sends a request to the\n[Cancel Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidcancel) API route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.cancel(\"exchange_123\")\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1425, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1426, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1427, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeResponse" + }, + "name": "AdminExchangeResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1428, + "name": "addInboundItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1429, + "name": "addInboundItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds inbound (or return) items to an exchange. These inbound items will \nhave the action " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": ".\n\nThis method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditems)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the exchange, with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.addInboundItems(\"exchange_123\", {\n items: [{\n id: \"orli_123\",\n quantity: 1\n }]\n})\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1430, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1431, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items to add." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminAddExchangeInboundItems" + }, + "name": "AdminAddExchangeInboundItems", + "package": "@medusajs/types" + } + }, + { + "id": 1432, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1433, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeReturnResponse" + }, + "name": "AdminExchangeReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1434, + "name": "updateInboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1435, + "name": "updateInboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates an inbound (or return) item from an exchange using the ID of \nthe item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. You can \ncheck the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditemsaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the exchange, with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.updateInboundItem(\n \"exchange_123\", \n \"ordchact_123\",\n {\n quantity: 1\n }\n)\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1436, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1437, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the return item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1438, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminUpdateExchangeInboundItem" + }, + "name": "AdminUpdateExchangeInboundItem", + "package": "@medusajs/types" + } + }, + { + "id": 1439, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1440, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeReturnResponse" + }, + "name": "AdminExchangeReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1441, + "name": "removeInboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1442, + "name": "removeInboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes an inbound (or return) item from an exchange using the ID of the \nitem's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the exchange, with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.removeInboundItem(\n \"exchange_123\", \n \"ordchact_123\",\n)\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1443, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1444, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the return item's " + }, + { + "kind": "code", + "text": "`RETURN_ITEM`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1445, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1446, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeReturnResponse" + }, + "name": "AdminExchangeReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1447, + "name": "addInboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1448, + "name": "addInboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds an inbound (or return) shipping method to an exchange. \nThe inbound shipping method will have a " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nThis method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)\nAPI route.\n\nThis method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the exchange, with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.addInboundShipping(\"exchange_123\", {\n shipping_option_id: \"so_123\"\n})\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1449, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1450, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminExchangeAddInboundShipping" + }, + "name": "AdminExchangeAddInboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1451, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1452, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeReturnResponse" + }, + "name": "AdminExchangeReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1453, + "name": "updateInboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1454, + "name": "updateInboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates the shipping method for returning items in the exchange using the ID \nof the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the exchange, with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.updateInboundShipping(\n \"exchange_123\",\n \"ordchact_123\",\n {\n custom_amount: 10\n }\n)\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1455, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1456, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1457, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminExchangeUpdateInboundShipping" + }, + "name": "AdminExchangeUpdateInboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1458, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1459, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeReturnResponse" + }, + "name": "AdminExchangeReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1460, + "name": "deleteInboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1461, + "name": "deleteInboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes the shipping method for returning items in the exchange using the ID \nof the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the return associated with the exchange, with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.deleteInboundShipping(\n \"exchange_123\",\n \"ordchact_123\",\n)\n.then(({ return: returnData }) => {\n console.log(returnData)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1462, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1463, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1464, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the return." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1465, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeReturnResponse" + }, + "name": "AdminExchangeReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1466, + "name": "addOutboundItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1467, + "name": "addOutboundItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds outbound (or new) items to an exchange. \nThese outbound items will have the action " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": ".\n\nThis method sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditems)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.addOutboundItems(\"exchange_123\", {\n items: [{\n id: \"variant_123\",\n quantity: 1\n }]\n})\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1468, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1469, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items to add." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminAddExchangeOutboundItems" + }, + "name": "AdminAddExchangeOutboundItems", + "package": "@medusajs/types" + } + }, + { + "id": 1470, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1471, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangePreviewResponse" + }, + "name": "AdminExchangePreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1472, + "name": "updateOutboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1473, + "name": "updateOutboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates an outbound (or new) item from an exchange using the ID \nof the item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditemsaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.updateOutboundItem(\n \"exchange_123\",\n \"ordchact_123\",\n {\n quantity: 1\n }\n)\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1474, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1475, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the new exchange item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1476, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The item's details to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminUpdateExchangeOutboundItem" + }, + "name": "AdminUpdateExchangeOutboundItem", + "package": "@medusajs/types" + } + }, + { + "id": 1477, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1478, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangePreviewResponse" + }, + "name": "AdminExchangePreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1479, + "name": "removeOutboundItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1480, + "name": "removeOutboundItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes an outbound (or new) item from an exchange using the ID \nof the item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery item has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.removeOutboundItem(\n \"exchange_123\",\n \"ordchact_123\",\n)\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1481, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1482, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the new exchange item's " + }, + { + "kind": "code", + "text": "`ITEM_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1483, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1484, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangePreviewResponse" + }, + "name": "AdminExchangePreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1485, + "name": "addOutboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1486, + "name": "addOutboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds an outbound shipping method to an exchange. The outbound shipping method \nwill have a " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nThis method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethod)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.addOutboundShipping(\"exchange_123\", {\n shipping_option_id: \"so_123\"\n})\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1487, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1488, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminExchangeAddOutboundShipping" + }, + "name": "AdminExchangeAddOutboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1489, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1490, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangePreviewResponse" + }, + "name": "AdminExchangePreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1491, + "name": "updateOutboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1492, + "name": "updateOutboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates the shipping method for delivering outbound items in the exchange using \nthe ID of the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.updateOutboundShipping(\n \"exchange_123\",\n \"ordchact_123\",\n {\n custom_amount: 10\n }\n)\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1493, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1494, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1495, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminExchangeUpdateOutboundShipping" + }, + "name": "AdminExchangeUpdateOutboundShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1496, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1497, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangePreviewResponse" + }, + "name": "AdminExchangePreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1498, + "name": "deleteOutboundShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1499, + "name": "deleteOutboundShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method removes the shipping method for delivering outbound items in the exchange using \nthe ID of the method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action.\n\nEvery shipping method has an " + }, + { + "kind": "code", + "text": "`actions`" + }, + { + "kind": "text", + "text": " property, whose value is an array of actions. \nYou can check the action's name using its " + }, + { + "kind": "code", + "text": "`action`" + }, + { + "kind": "text", + "text": " property, and use the value of the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " property.\n\nThis method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.deleteOutboundShipping(\n \"exchange_123\",\n \"ordchact_123\",\n)\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1500, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1501, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the shipping method's " + }, + { + "kind": "code", + "text": "`SHIPPING_ADD`" + }, + { + "kind": "text", + "text": " action." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1502, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1503, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangePreviewResponse" + }, + "name": "AdminExchangePreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1504, + "name": "request", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1505, + "name": "request", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method confirms an exchange request, applying its changes on the associated order.\n\nThis method sends a request to the [Confirm Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidrequest)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The exchange and associated return's details with a preview of the order when the exchange is applied." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.request(\"exchange_123\", {})\n.then(({ exchange }) => {\n console.log(exchange)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1506, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1507, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The confirmation's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/payloads.ts", + "qualifiedName": "AdminRequestExchange" + }, + "name": "AdminRequestExchange", + "package": "@medusajs/types" + } + }, + { + "id": 1508, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1509, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeRequestResponse" + }, + "name": "AdminExchangeRequestResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1510, + "name": "cancelRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1511, + "name": "cancelRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method cancels an exchange request. It sends a request to the\n[Cancel Exchange Request](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidrequest)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The cancelation's details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.admin.exchange.cancel(\"exchange_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1512, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The exchange's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1513, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the exchange." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1514, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/exchange/admin/responses.ts", + "qualifiedName": "AdminExchangeDeleteResponse" + }, + "name": "AdminExchangeDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1405 + ] + }, + { + "title": "Properties", + "children": [ + 1408 + ] + }, + { + "title": "Methods", + "children": [ + 1409, + 1413, + 1418, + 1423, + 1428, + 1434, + 1441, + 1447, + 1453, + 1460, + 1466, + 1472, + 1479, + 1485, + 1491, + 1498, + 1504, + 1510 + ] + } + ] + }, + { + "id": 878, + "name": "FulfillmentProvider", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 882, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 879, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 880, + "name": "new FulfillmentProvider", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 881, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 878, + "name": "FulfillmentProvider", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 883, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 884, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of fulfillment providers. It sends a request to the\n[List Fulfillment Providers](https://docs.medusajs.com/v2/api/admin#fulfillment-providers_getfulfillmentproviders)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of providers." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of fulfillment providers:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.fulfillmentProvider.list()\n.then(({ fulfillment_providers, count, limit, offset }) => {\n console.log(fulfillment_providers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.fulfillmentProvider.list({\n limit: 10,\n offset: 10\n})\n.then(({ fulfillment_providers, count, limit, offset }) => {\n console.log(fulfillment_providers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each fulfillment provider:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.admin.fulfillmentProvider.list({\n fields: \"id\"\n})\n.then(({ fulfillment_providers, count, limit, offset }) => {\n console.log(fulfillment_providers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "parameters": [ + { + "id": 885, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-provider/admin/queries.ts", + "qualifiedName": "AdminFulfillmentProviderListParams" + }, + "name": "AdminFulfillmentProviderListParams", + "package": "@medusajs/types" + } + }, + { + "id": 886, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-provider/admin/responses.ts", + "qualifiedName": "AdminFulfillmentProviderListResponse" + }, + "name": "AdminFulfillmentProviderListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 879 + ] + }, + { + "title": "Properties", + "children": [ + 882 + ] + }, + { + "title": "Methods", + "children": [ + 883 + ] + } + ] + }, + { + "id": 824, + "name": "FulfillmentSet", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 828, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 825, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 826, + "name": "new FulfillmentSet", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 827, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 824, + "name": "FulfillmentSet", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 829, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 830, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 831, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 832, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/responses.ts", + "qualifiedName": "AdminFulfillmentSetDeleteResponse" + }, + "name": "AdminFulfillmentSetDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 833, + "name": "createServiceZone", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 834, + "name": "createServiceZone", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 835, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 836, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/payloads.ts", + "qualifiedName": "AdminCreateFulfillmentSetServiceZone" + }, + "name": "AdminCreateFulfillmentSetServiceZone", + "package": "@medusajs/types" + } + }, + { + "id": 837, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 838, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/responses.ts", + "qualifiedName": "AdminFulfillmentSetResponse" + }, + "name": "AdminFulfillmentSetResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 839, + "name": "retrieveServiceZone", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 840, + "name": "retrieveServiceZone", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 841, + "name": "fulfillmentSetId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 842, + "name": "serviceZoneId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 843, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 844, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/responses.ts", + "qualifiedName": "AdminServiceZoneResponse" + }, + "name": "AdminServiceZoneResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 845, + "name": "updateServiceZone", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 846, + "name": "updateServiceZone", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 847, + "name": "fulfillmentSetId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 848, + "name": "serviceZoneId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 849, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/payloads.ts", + "qualifiedName": "AdminUpdateFulfillmentSetServiceZone" + }, + "name": "AdminUpdateFulfillmentSetServiceZone", + "package": "@medusajs/types" + } + }, + { + "id": 850, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 851, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/responses.ts", + "qualifiedName": "AdminFulfillmentSetResponse" + }, + "name": "AdminFulfillmentSetResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 852, + "name": "deleteServiceZone", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 853, + "name": "deleteServiceZone", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 854, + "name": "fulfillmentSetId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 855, + "name": "serviceZoneId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 856, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment-set/admin/responses.ts", + "qualifiedName": "AdminServiceZoneDeleteResponse" + }, + "name": "AdminServiceZoneDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 825 + ] + }, + { + "title": "Properties", + "children": [ + 828 + ] + }, + { + "title": "Methods", + "children": [ + 829, + 833, + 839, + 845, + 852 + ] + } + ] + }, + { + "id": 857, + "name": "Fulfillment", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 861, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 858, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 859, + "name": "new Fulfillment", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 860, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 857, + "name": "Fulfillment", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 862, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 863, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 864, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment/admin/payloads.ts", + "qualifiedName": "AdminCreateFulfillment" + }, + "name": "AdminCreateFulfillment", + "package": "@medusajs/types" + } + }, + { + "id": 865, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 866, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment/admin/responses.ts", + "qualifiedName": "AdminFulfillmentResponse" + }, + "name": "AdminFulfillmentResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 867, + "name": "cancel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 868, + "name": "cancel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 869, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 870, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 871, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment/admin/responses.ts", + "qualifiedName": "AdminFulfillmentResponse" + }, + "name": "AdminFulfillmentResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 872, + "name": "createShipment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 873, + "name": "createShipment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 874, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 875, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment/admin/payloads.ts", + "qualifiedName": "AdminCreateFulfillmentShipment" + }, + "name": "AdminCreateFulfillmentShipment", + "package": "@medusajs/types" + } + }, + { + "id": 876, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 877, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/fulfillment/admin/responses.ts", + "qualifiedName": "AdminFulfillmentResponse" + }, + "name": "AdminFulfillmentResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 858 + ] + }, + { + "title": "Properties", + "children": [ + 861 + ] + }, + { + "title": "Methods", + "children": [ + 862, + 867, + 872 + ] + } + ] + }, + { + "id": 2, + "name": "Admin", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 6, + "name": "invite", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 288, + "name": "Invite", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 7, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 332, + "name": "Customer", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 8, + "name": "productCollection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 361, + "name": "ProductCollection", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 9, + "name": "productCategory", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 395, + "name": "ProductCategory", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 10, + "name": "priceList", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 430, + "name": "PriceList", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 11, + "name": "pricePreference", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 471, + "name": "PricePreference", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 12, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 500, + "name": "Product", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 13, + "name": "productType", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 622, + "name": "ProductType", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 14, + "name": "upload", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 651, + "name": "Upload", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 15, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 674, + "name": "Region", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 16, + "name": "returnReason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 711, + "name": "ReturnReason", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 17, + "name": "stockLocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 741, + "name": "StockLocation", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 18, + "name": "salesChannel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 785, + "name": "SalesChannel", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 19, + "name": "fulfillmentSet", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 824, + "name": "FulfillmentSet", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 20, + "name": "fulfillment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 857, + "name": "Fulfillment", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 21, + "name": "fulfillmentProvider", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 878, + "name": "FulfillmentProvider", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 22, + "name": "shippingOption", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 887, + "name": "ShippingOption", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 23, + "name": "shippingProfile", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 921, + "name": "ShippingProfile", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 24, + "name": "inventoryItem", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 950, + "name": "InventoryItem", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 25, + "name": "notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1002, + "name": "Notification", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 26, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1016, + "name": "Order", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 27, + "name": "orderEdit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1089, + "name": "OrderEdit", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 28, + "name": "return", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1140, + "name": "Return", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 29, + "name": "claim", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1274, + "name": "Claim", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 30, + "name": "exchange", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1404, + "name": "Exchange", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 31, + "name": "taxRate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1515, + "name": "TaxRate", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 32, + "name": "taxRegion", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1544, + "name": "TaxRegion", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 33, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1567, + "name": "Store", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 34, + "name": "productTag", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1587, + "name": "ProductTag", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 35, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1616, + "name": "User", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 36, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1649, + "name": "Currency", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 37, + "name": "payment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1663, + "name": "Payment", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 38, + "name": "productVariant", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1693, + "name": "ProductVariant", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 39, + "name": "refundReason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1702, + "name": "RefundReason", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 40, + "name": "paymentCollection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1711, + "name": "PaymentCollection", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 41, + "name": "apiKey", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1740, + "name": "ApiKey", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 42, + "name": "workflowExecution", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1777, + "name": "WorkflowExecution", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 43, + "name": "reservation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1790, + "name": "Reservation", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 44, + "name": "customerGroup", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1819, + "name": "CustomerGroup", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 45, + "name": "promotion", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1853, + "name": "Promotion", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 46, + "name": "campaign", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 1915, + "name": "Campaign", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 3, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4, + "name": "new Admin", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 5, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 2, + "name": "Admin", + "package": "@medusajs/js-sdk" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3 + ] + }, + { + "title": "Properties", + "children": [ + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ] + } + ] + }, + { + "id": 950, + "name": "InventoryItem", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 954, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 951, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 952, + "name": "new InventoryItem", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 953, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 950, + "name": "InventoryItem", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 955, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 956, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 957, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/payloads.ts", + "qualifiedName": "AdminCreateInventoryItem" + }, + "name": "AdminCreateInventoryItem", + "package": "@medusajs/types" + } + }, + { + "id": 958, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 959, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemResponse" + }, + "name": "AdminInventoryItemResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 960, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 961, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 962, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 963, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/payloads.ts", + "qualifiedName": "AdminUpdateInventoryItem" + }, + "name": "AdminUpdateInventoryItem", + "package": "@medusajs/types" + } + }, + { + "id": 964, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 965, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemResponse" + }, + "name": "AdminInventoryItemResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 966, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 967, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 968, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/queries.ts", + "qualifiedName": "AdminInventoryItemParams" + }, + "name": "AdminInventoryItemParams", + "package": "@medusajs/types" + } + }, + { + "id": 969, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemListResponse" + }, + "name": "AdminInventoryItemListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 970, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 971, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 972, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 973, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 974, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemResponse" + }, + "name": "AdminInventoryItemResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 975, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 976, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 977, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 978, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemDeleteResponse" + }, + "name": "AdminInventoryItemDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 979, + "name": "listLevels", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 980, + "name": "listLevels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 981, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 982, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory-level/admin/queries.ts", + "qualifiedName": "AdminInventoryLevelFilters" + }, + "name": "AdminInventoryLevelFilters", + "package": "@medusajs/types" + } + }, + { + "id": 983, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory-level/admin/responses.ts", + "qualifiedName": "AdminInventoryLevelListResponse" + }, + "name": "AdminInventoryLevelListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 984, + "name": "updateLevel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 985, + "name": "updateLevel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 986, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 987, + "name": "locationId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 988, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory-level/admin/payloads.ts", + "qualifiedName": "AdminUpdateInventoryLevel" + }, + "name": "AdminUpdateInventoryLevel", + "package": "@medusajs/types" + } + }, + { + "id": 989, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 990, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemResponse" + }, + "name": "AdminInventoryItemResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 991, + "name": "deleteLevel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 992, + "name": "deleteLevel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 993, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 994, + "name": "locationId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 995, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemDeleteResponse" + }, + "name": "AdminInventoryItemDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 996, + "name": "batchUpdateLevels", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 997, + "name": "batchUpdateLevels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 998, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 999, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory-level/admin/payloads.ts", + "qualifiedName": "AdminBatchUpdateInventoryLevelLocation" + }, + "name": "AdminBatchUpdateInventoryLevelLocation", + "package": "@medusajs/types" + } + }, + { + "id": 1000, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1001, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/inventory/admin/responses.ts", + "qualifiedName": "AdminInventoryItemResponse" + }, + "name": "AdminInventoryItemResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 951 + ] + }, + { + "title": "Properties", + "children": [ + 954 + ] + }, + { + "title": "Methods", + "children": [ + 955, + 960, + 966, + 970, + 975, + 979, + 984, + 991, + 996 + ] + } + ] + }, + { + "id": 288, + "name": "Invite", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 292, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 289, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 290, + "name": "new Invite", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 291, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 288, + "name": "Invite", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 293, + "name": "accept", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 294, + "name": "accept", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 295, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/payloads.ts", + "qualifiedName": "AdminAcceptInvite" + }, + "name": "AdminAcceptInvite", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 296, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 297, + "name": "invite_token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 297 + ] + } + ] + } + } + ] + } + }, + { + "id": 298, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 299, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 300, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 301, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserResponse" + }, + "name": "AdminUserResponse", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 301 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 302, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 303, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 304, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/payloads.ts", + "qualifiedName": "AdminCreateInvite" + }, + "name": "AdminCreateInvite", + "package": "@medusajs/types" + } + }, + { + "id": 305, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 306, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 307, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 308, + "name": "invite", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/responses.ts", + "qualifiedName": "AdminInviteResponse" + }, + "name": "AdminInviteResponse", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 308 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 309, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 310, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 311, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 312, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 313, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 314, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 315, + "name": "invite", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/responses.ts", + "qualifiedName": "AdminInviteResponse" + }, + "name": "AdminInviteResponse", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 315 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 316, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 317, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 318, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + } + }, + { + "id": 319, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "PaginatedResponse" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 320, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 321, + "name": "invites", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/responses.ts", + "qualifiedName": "AdminInviteResponse" + }, + "name": "AdminInviteResponse", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 321 + ] + } + ] + } + } + ], + "name": "PaginatedResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 322, + "name": "resend", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 323, + "name": "resend", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 324, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 326, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 327, + "name": "invite", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/responses.ts", + "qualifiedName": "AdminInviteResponse" + }, + "name": "AdminInviteResponse", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 327 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 328, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 329, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 330, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 331, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/invite/admin/responses.ts", + "qualifiedName": "AdminInviteDeleteResponse" + }, + "name": "AdminInviteDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 289 + ] + }, + { + "title": "Properties", + "children": [ + 292 + ] + }, + { + "title": "Methods", + "children": [ + 293, + 302, + 309, + 316, + 322, + 328 + ] + } + ] + }, + { + "id": 1002, + "name": "Notification", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1006, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1003, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1004, + "name": "new Notification", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1005, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1002, + "name": "Notification", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1007, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1008, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1009, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1010, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/notification/admin/queries.ts", + "qualifiedName": "AdminNotificationParams" + }, + "name": "AdminNotificationParams", + "package": "@medusajs/types" + } + }, + { + "id": 1011, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/notification/admin/responses.ts", + "qualifiedName": "AdminNotificationResponse" + }, + "name": "AdminNotificationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1012, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1013, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1014, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/notification/admin/queries.ts", + "qualifiedName": "AdminNotificationListParams" + }, + "name": "AdminNotificationListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1015, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/notification/admin/responses.ts", + "qualifiedName": "AdminNotificationListResponse" + }, + "name": "AdminNotificationListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1003 + ] + }, + { + "title": "Properties", + "children": [ + 1006 + ] + }, + { + "title": "Methods", + "children": [ + 1007, + 1012 + ] + } + ] + }, + { + "id": 1089, + "name": "OrderEdit", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1093, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1090, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1091, + "name": "new OrderEdit", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1092, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1089, + "name": "OrderEdit", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1094, + "name": "initiateRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1095, + "name": "initiateRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1096, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/payloads.ts", + "qualifiedName": "AdminInitiateOrderEditRequest" + }, + "name": "AdminInitiateOrderEditRequest", + "package": "@medusajs/types" + } + }, + { + "id": 1097, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1098, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1099, + "name": "request", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1100, + "name": "request", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1101, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1102, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1103, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1104, + "name": "confirm", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1105, + "name": "confirm", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1106, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1107, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1108, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1109, + "name": "cancelRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1110, + "name": "cancelRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1111, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1112, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1113, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditDeleteResponse" + }, + "name": "AdminOrderEditDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1114, + "name": "addItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1115, + "name": "addItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1116, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1117, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/payloads.ts", + "qualifiedName": "AdminAddOrderEditItems" + }, + "name": "AdminAddOrderEditItems", + "package": "@medusajs/types" + } + }, + { + "id": 1118, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1119, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1120, + "name": "updateOriginalItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1121, + "name": "updateOriginalItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1122, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1123, + "name": "itemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1124, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/payloads.ts", + "qualifiedName": "AdminUpdateOrderEditItem" + }, + "name": "AdminUpdateOrderEditItem", + "package": "@medusajs/types" + } + }, + { + "id": 1125, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1126, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1127, + "name": "updateAddedItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1128, + "name": "updateAddedItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1129, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1130, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1131, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/payloads.ts", + "qualifiedName": "AdminUpdateOrderEditItem" + }, + "name": "AdminUpdateOrderEditItem", + "package": "@medusajs/types" + } + }, + { + "id": 1132, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1133, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1134, + "name": "removeAddedItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1135, + "name": "removeAddedItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1136, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1137, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1138, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1139, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order-edit/admin/responses.ts", + "qualifiedName": "AdminOrderEditPreviewResponse" + }, + "name": "AdminOrderEditPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1090 + ] + }, + { + "title": "Properties", + "children": [ + 1093 + ] + }, + { + "title": "Methods", + "children": [ + 1094, + 1099, + 1104, + 1109, + 1114, + 1120, + 1127, + 1134 + ] + } + ] + }, + { + "id": 1016, + "name": "Order", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1020, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1017, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1018, + "name": "new Order", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1019, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1016, + "name": "Order", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1021, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1022, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1023, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1024, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1025, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1026, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1027, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1027 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1028, + "name": "retrievePreview", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1029, + "name": "retrievePreview", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1030, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1031, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/queries.ts", + "qualifiedName": "AdminOrderFilters" + }, + "name": "AdminOrderFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1032, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/responses.ts", + "qualifiedName": "AdminOrderPreviewResponse" + }, + "name": "AdminOrderPreviewResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1033, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1034, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1035, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/queries.ts", + "qualifiedName": "AdminOrderFilters" + }, + "name": "AdminOrderFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1036, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "PaginatedResponse" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1037, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1038, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1038 + ] + } + ] + } + } + ], + "name": "PaginatedResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1039, + "name": "cancel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1040, + "name": "cancel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1041, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1042, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1043, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1044, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1044 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1045, + "name": "createFulfillment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1046, + "name": "createFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1047, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1048, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/payload.ts", + "qualifiedName": "AdminCreateOrderFulfillment" + }, + "name": "AdminCreateOrderFulfillment", + "package": "@medusajs/types" + } + }, + { + "id": 1049, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1050, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1051, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1052, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1052 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1053, + "name": "cancelFulfillment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1054, + "name": "cancelFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1055, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1056, + "name": "fulfillmentId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1057, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/payload.ts", + "qualifiedName": "AdminCancelOrderFulfillment" + }, + "name": "AdminCancelOrderFulfillment", + "package": "@medusajs/types" + } + }, + { + "id": 1058, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1059, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1060, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1060 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1061, + "name": "createShipment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1062, + "name": "createShipment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1063, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "fulfillmentId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1065, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/payload.ts", + "qualifiedName": "AdminCreateOrderShipment" + }, + "name": "AdminCreateOrderShipment", + "package": "@medusajs/types" + } + }, + { + "id": 1066, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1067, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1068, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1069, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1069 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1070, + "name": "markAsDelivered", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1071, + "name": "markAsDelivered", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1072, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1073, + "name": "fulfillmentId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1074, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/payload.ts", + "qualifiedName": "AdminMarkOrderFulfillmentAsDelivered" + }, + "name": "AdminMarkOrderFulfillmentAsDelivered", + "package": "@medusajs/types" + } + }, + { + "id": 1075, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1076, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 1077, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1078, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/entities.ts", + "qualifiedName": "AdminOrder" + }, + "name": "AdminOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1078 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1079, + "name": "listChanges", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1080, + "name": "listChanges", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1081, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1082, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/queries.ts", + "qualifiedName": "AdminOrderChangesFilters" + }, + "name": "AdminOrderChangesFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1083, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "PaginatedResponse" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/responses.ts", + "qualifiedName": "AdminOrderChangesResponse" + }, + "name": "AdminOrderChangesResponse", + "package": "@medusajs/types" + } + ], + "name": "PaginatedResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1084, + "name": "listLineItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1085, + "name": "listLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1086, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1087, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/queries.ts", + "qualifiedName": "AdminOrderItemsFilters" + }, + "name": "AdminOrderItemsFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1088, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "PaginatedResponse" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/admin/responses.ts", + "qualifiedName": "AdminOrderLineItemsListResponse" + }, + "name": "AdminOrderLineItemsListResponse", + "package": "@medusajs/types" + } + ], + "name": "PaginatedResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1017 + ] + }, + { + "title": "Properties", + "children": [ + 1020 + ] + }, + { + "title": "Methods", + "children": [ + 1021, + 1028, + 1033, + 1039, + 1045, + 1053, + 1061, + 1070, + 1079, + 1084 + ] + } + ] + }, + { + "id": 1711, + "name": "PaymentCollection", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1715, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1712, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1713, + "name": "new PaymentCollection", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1714, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1711, + "name": "PaymentCollection", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1716, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1717, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1718, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/queries.ts", + "qualifiedName": "AdminPaymentCollectionFilters" + }, + "name": "AdminPaymentCollectionFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1719, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentCollectionsResponse" + }, + "name": "AdminPaymentCollectionsResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1720, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1721, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1722, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1723, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/queries.ts", + "qualifiedName": "AdminPaymentCollectionFilters" + }, + "name": "AdminPaymentCollectionFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1724, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentCollectionResponse" + }, + "name": "AdminPaymentCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1725, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1726, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1727, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/payloads.ts", + "qualifiedName": "AdminCreatePaymentCollection" + }, + "name": "AdminCreatePaymentCollection", + "package": "@medusajs/types" + } + }, + { + "id": 1728, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1729, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentCollectionResponse" + }, + "name": "AdminPaymentCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1730, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1731, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1732, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1733, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminDeletePaymentCollectionResponse" + }, + "name": "AdminDeletePaymentCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1734, + "name": "markAsPaid", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1735, + "name": "markAsPaid", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1736, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1737, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/payloads.ts", + "qualifiedName": "AdminMarkPaymentCollectionAsPaid" + }, + "name": "AdminMarkPaymentCollectionAsPaid", + "package": "@medusajs/types" + } + }, + { + "id": 1738, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1739, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentCollectionResponse" + }, + "name": "AdminPaymentCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1712 + ] + }, + { + "title": "Properties", + "children": [ + 1715 + ] + }, + { + "title": "Methods", + "children": [ + 1716, + 1720, + 1725, + 1730, + 1734 + ] + } + ] + }, + { + "id": 1663, + "name": "Payment", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1667, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1664, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1665, + "name": "new Payment", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1666, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1663, + "name": "Payment", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1668, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1669, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1670, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/queries.ts", + "qualifiedName": "AdminPaymentFilters" + }, + "name": "AdminPaymentFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1671, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentsResponse" + }, + "name": "AdminPaymentsResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1672, + "name": "listPaymentProviders", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1673, + "name": "listPaymentProviders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1674, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/queries.ts", + "qualifiedName": "AdminGetPaymentProvidersParams" + }, + "name": "AdminGetPaymentProvidersParams", + "package": "@medusajs/types" + } + }, + { + "id": 1675, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentProviderListResponse" + }, + "name": "AdminPaymentProviderListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1676, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1677, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1678, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1679, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/queries.ts", + "qualifiedName": "AdminPaymentFilters" + }, + "name": "AdminPaymentFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1680, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentResponse" + }, + "name": "AdminPaymentResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1681, + "name": "capture", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1682, + "name": "capture", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1683, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1684, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/payloads.ts", + "qualifiedName": "AdminCapturePayment" + }, + "name": "AdminCapturePayment", + "package": "@medusajs/types" + } + }, + { + "id": 1685, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1686, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentResponse" + }, + "name": "AdminPaymentResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1687, + "name": "refund", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1688, + "name": "refund", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1689, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1690, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/payloads.ts", + "qualifiedName": "AdminRefundPayment" + }, + "name": "AdminRefundPayment", + "package": "@medusajs/types" + } + }, + { + "id": 1691, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1692, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "AdminPaymentResponse" + }, + "name": "AdminPaymentResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1664 + ] + }, + { + "title": "Properties", + "children": [ + 1667 + ] + }, + { + "title": "Methods", + "children": [ + 1668, + 1672, + 1676, + 1681, + 1687 + ] + } + ] + }, + { + "id": 430, + "name": "PriceList", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 434, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 431, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 432, + "name": "new PriceList", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 433, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 430, + "name": "PriceList", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 435, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 436, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 437, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 438, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/queries.ts", + "qualifiedName": "AdminPriceListParams" + }, + "name": "AdminPriceListParams", + "package": "@medusajs/types" + } + }, + { + "id": 439, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListResponse" + }, + "name": "AdminPriceListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 440, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 441, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 442, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/queries.ts", + "qualifiedName": "AdminPriceListListParams" + }, + "name": "AdminPriceListListParams", + "package": "@medusajs/types" + } + }, + { + "id": 443, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListListResponse" + }, + "name": "AdminPriceListListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 444, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 445, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 446, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/payloads.ts", + "qualifiedName": "AdminCreatePriceList" + }, + "name": "AdminCreatePriceList", + "package": "@medusajs/types" + } + }, + { + "id": 447, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/queries.ts", + "qualifiedName": "AdminPriceListParams" + }, + "name": "AdminPriceListParams", + "package": "@medusajs/types" + } + }, + { + "id": 448, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListResponse" + }, + "name": "AdminPriceListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 449, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 450, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 451, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 452, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/payloads.ts", + "qualifiedName": "AdminUpdatePriceList" + }, + "name": "AdminUpdatePriceList", + "package": "@medusajs/types" + } + }, + { + "id": 453, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/queries.ts", + "qualifiedName": "AdminPriceListParams" + }, + "name": "AdminPriceListParams", + "package": "@medusajs/types" + } + }, + { + "id": 454, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListResponse" + }, + "name": "AdminPriceListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 455, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 456, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 457, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 458, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListDeleteResponse" + }, + "name": "AdminPriceListDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 459, + "name": "batchPrices", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 460, + "name": "batchPrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 461, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 462, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/payloads.ts", + "qualifiedName": "AdminBatchPriceListPrice" + }, + "name": "AdminBatchPriceListPrice", + "package": "@medusajs/types" + } + }, + { + "id": 463, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/queries.ts", + "qualifiedName": "AdminPriceListParams" + }, + "name": "AdminPriceListParams", + "package": "@medusajs/types" + } + }, + { + "id": 464, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListResponse" + }, + "name": "AdminPriceListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 465, + "name": "linkProducts", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 466, + "name": "linkProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 467, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/payloads.ts", + "qualifiedName": "AdminLinkPriceListProducts" + }, + "name": "AdminLinkPriceListProducts", + "package": "@medusajs/types" + } + }, + { + "id": 469, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/queries.ts", + "qualifiedName": "AdminPriceListParams" + }, + "name": "AdminPriceListParams", + "package": "@medusajs/types" + } + }, + { + "id": 470, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/price-list/admin/responses.ts", + "qualifiedName": "AdminPriceListResponse" + }, + "name": "AdminPriceListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 431 + ] + }, + { + "title": "Properties", + "children": [ + 434 + ] + }, + { + "title": "Methods", + "children": [ + 435, + 440, + 444, + 449, + 455, + 459, + 465 + ] + } + ] + }, + { + "id": 471, + "name": "PricePreference", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 475, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 472, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 473, + "name": "new PricePreference", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 474, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 471, + "name": "PricePreference", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 476, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 477, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 478, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 479, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/queries.ts", + "qualifiedName": "AdminPricePreferenceParams" + }, + "name": "AdminPricePreferenceParams", + "package": "@medusajs/types" + } + }, + { + "id": 480, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/responses.ts", + "qualifiedName": "AdminPricePreferenceResponse" + }, + "name": "AdminPricePreferenceResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 481, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 482, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 483, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/queries.ts", + "qualifiedName": "AdminPricePreferenceListParams" + }, + "name": "AdminPricePreferenceListParams", + "package": "@medusajs/types" + } + }, + { + "id": 484, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/responses.ts", + "qualifiedName": "AdminPricePreferenceListResponse" + }, + "name": "AdminPricePreferenceListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 485, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 486, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 487, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/payloads.ts", + "qualifiedName": "AdminCreatePricePreference" + }, + "name": "AdminCreatePricePreference", + "package": "@medusajs/types" + } + }, + { + "id": 488, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/queries.ts", + "qualifiedName": "AdminPricePreferenceParams" + }, + "name": "AdminPricePreferenceParams", + "package": "@medusajs/types" + } + }, + { + "id": 489, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/responses.ts", + "qualifiedName": "AdminPricePreferenceResponse" + }, + "name": "AdminPricePreferenceResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 490, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 491, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 492, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 493, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/payloads.ts", + "qualifiedName": "AdminUpdatePricePreference" + }, + "name": "AdminUpdatePricePreference", + "package": "@medusajs/types" + } + }, + { + "id": 494, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/queries.ts", + "qualifiedName": "AdminPricePreferenceParams" + }, + "name": "AdminPricePreferenceParams", + "package": "@medusajs/types" + } + }, + { + "id": 495, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/responses.ts", + "qualifiedName": "AdminPricePreferenceResponse" + }, + "name": "AdminPricePreferenceResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 496, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 497, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 498, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 499, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/pricing/admin/responses.ts", + "qualifiedName": "AdminPricePreferenceDeleteResponse" + }, + "name": "AdminPricePreferenceDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 472 + ] + }, + { + "title": "Properties", + "children": [ + 475 + ] + }, + { + "title": "Methods", + "children": [ + 476, + 481, + 485, + 490, + 496 + ] + } + ] + }, + { + "id": 395, + "name": "ProductCategory", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 399, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 396, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 397, + "name": "new ProductCategory", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 398, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 395, + "name": "ProductCategory", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 400, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 401, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 402, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/payloads.ts", + "qualifiedName": "AdminCreateProductCategory" + }, + "name": "AdminCreateProductCategory", + "package": "@medusajs/types" + } + }, + { + "id": 403, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/queries.ts", + "qualifiedName": "AdminProductCategoryParams" + }, + "name": "AdminProductCategoryParams", + "package": "@medusajs/types" + } + }, + { + "id": 404, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/responses.ts", + "qualifiedName": "AdminProductCategoryResponse" + }, + "name": "AdminProductCategoryResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 405, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 406, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 407, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 408, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/payloads.ts", + "qualifiedName": "AdminUpdateProductCategory" + }, + "name": "AdminUpdateProductCategory", + "package": "@medusajs/types" + } + }, + { + "id": 409, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/queries.ts", + "qualifiedName": "AdminProductCategoryParams" + }, + "name": "AdminProductCategoryParams", + "package": "@medusajs/types" + } + }, + { + "id": 410, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/responses.ts", + "qualifiedName": "AdminProductCategoryResponse" + }, + "name": "AdminProductCategoryResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 411, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 412, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 413, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/queries.ts", + "qualifiedName": "AdminProductCategoryListParams" + }, + "name": "AdminProductCategoryListParams", + "package": "@medusajs/types" + } + }, + { + "id": 414, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/responses.ts", + "qualifiedName": "AdminProductCategoryListResponse" + }, + "name": "AdminProductCategoryListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 415, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 416, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 417, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 418, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/queries.ts", + "qualifiedName": "AdminProductCategoryParams" + }, + "name": "AdminProductCategoryParams", + "package": "@medusajs/types" + } + }, + { + "id": 419, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/responses.ts", + "qualifiedName": "AdminProductCategoryResponse" + }, + "name": "AdminProductCategoryResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 420, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 421, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 422, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 423, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/responses.ts", + "qualifiedName": "AdminProductCategoryDeleteResponse" + }, + "name": "AdminProductCategoryDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 424, + "name": "updateProducts", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 425, + "name": "updateProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 426, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/payloads.ts", + "qualifiedName": "AdminUpdateProductCategoryProducts" + }, + "name": "AdminUpdateProductCategoryProducts", + "package": "@medusajs/types" + } + }, + { + "id": 428, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/queries.ts", + "qualifiedName": "AdminProductCategoryParams" + }, + "name": "AdminProductCategoryParams", + "package": "@medusajs/types" + } + }, + { + "id": 429, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/admin/responses.ts", + "qualifiedName": "AdminProductCategoryResponse" + }, + "name": "AdminProductCategoryResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 396 + ] + }, + { + "title": "Properties", + "children": [ + 399 + ] + }, + { + "title": "Methods", + "children": [ + 400, + 405, + 411, + 415, + 420, + 424 + ] + } + ] + }, + { + "id": 361, + "name": "ProductCollection", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 365, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 362, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 363, + "name": "new ProductCollection", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 364, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 361, + "name": "ProductCollection", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 366, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 367, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 368, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/payloads.ts", + "qualifiedName": "AdminCreateCollection" + }, + "name": "AdminCreateCollection", + "package": "@medusajs/types" + } + }, + { + "id": 369, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/queries.ts", + "qualifiedName": "AdminCollectionParams" + }, + "name": "AdminCollectionParams", + "package": "@medusajs/types" + } + }, + { + "id": 370, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/responses.ts", + "qualifiedName": "AdminCollectionResponse" + }, + "name": "AdminCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 371, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 372, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 373, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 374, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/payloads.ts", + "qualifiedName": "AdminUpdateCollection" + }, + "name": "AdminUpdateCollection", + "package": "@medusajs/types" + } + }, + { + "id": 375, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/queries.ts", + "qualifiedName": "AdminCollectionParams" + }, + "name": "AdminCollectionParams", + "package": "@medusajs/types" + } + }, + { + "id": 376, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/responses.ts", + "qualifiedName": "AdminCollectionResponse" + }, + "name": "AdminCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 377, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 378, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 379, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/queries.ts", + "qualifiedName": "AdminCollectionListParams" + }, + "name": "AdminCollectionListParams", + "package": "@medusajs/types" + } + }, + { + "id": 380, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/responses.ts", + "qualifiedName": "AdminCollectionListResponse" + }, + "name": "AdminCollectionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 381, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 382, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 383, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 384, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/queries.ts", + "qualifiedName": "AdminCollectionParams" + }, + "name": "AdminCollectionParams", + "package": "@medusajs/types" + } + }, + { + "id": 385, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/responses.ts", + "qualifiedName": "AdminCollectionResponse" + }, + "name": "AdminCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 386, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 387, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 388, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 389, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/responses.ts", + "qualifiedName": "AdminCollectionDeleteResponse" + }, + "name": "AdminCollectionDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 390, + "name": "updateProducts", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 391, + "name": "updateProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 392, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 393, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/payloads.ts", + "qualifiedName": "AdminUpdateCollectionProducts" + }, + "name": "AdminUpdateCollectionProducts", + "package": "@medusajs/types" + } + }, + { + "id": 394, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/admin/responses.ts", + "qualifiedName": "AdminCollectionResponse" + }, + "name": "AdminCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 362 + ] + }, + { + "title": "Properties", + "children": [ + 365 + ] + }, + { + "title": "Methods", + "children": [ + 366, + 371, + 377, + 381, + 386, + 390 + ] + } + ] + }, + { + "id": 1587, + "name": "ProductTag", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1591, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1588, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1589, + "name": "new ProductTag", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1590, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1587, + "name": "ProductTag", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1592, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1593, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1594, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/payloads.ts", + "qualifiedName": "AdminCreateProductTag" + }, + "name": "AdminCreateProductTag", + "package": "@medusajs/types" + } + }, + { + "id": 1595, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/queries.ts", + "qualifiedName": "AdminProductTagParams" + }, + "name": "AdminProductTagParams", + "package": "@medusajs/types" + } + }, + { + "id": 1596, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/responses.ts", + "qualifiedName": "AdminProductTagResponse" + }, + "name": "AdminProductTagResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1597, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1598, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1599, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1600, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/payloads.ts", + "qualifiedName": "AdminUpdateProductTag" + }, + "name": "AdminUpdateProductTag", + "package": "@medusajs/types" + } + }, + { + "id": 1601, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/queries.ts", + "qualifiedName": "AdminProductTagParams" + }, + "name": "AdminProductTagParams", + "package": "@medusajs/types" + } + }, + { + "id": 1602, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/responses.ts", + "qualifiedName": "AdminProductTagResponse" + }, + "name": "AdminProductTagResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1603, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1604, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1605, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/queries.ts", + "qualifiedName": "AdminProductTagListParams" + }, + "name": "AdminProductTagListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1606, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/responses.ts", + "qualifiedName": "AdminProductTagListResponse" + }, + "name": "AdminProductTagListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1607, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1608, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1609, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1610, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/queries.ts", + "qualifiedName": "AdminProductTagParams" + }, + "name": "AdminProductTagParams", + "package": "@medusajs/types" + } + }, + { + "id": 1611, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/responses.ts", + "qualifiedName": "AdminProductTagResponse" + }, + "name": "AdminProductTagResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1612, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1613, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1614, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1615, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-tag/admin/responses.ts", + "qualifiedName": "AdminProductTagDeleteResponse" + }, + "name": "AdminProductTagDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1588 + ] + }, + { + "title": "Properties", + "children": [ + 1591 + ] + }, + { + "title": "Methods", + "children": [ + 1592, + 1597, + 1603, + 1607, + 1612 + ] + } + ] + }, + { + "id": 622, + "name": "ProductType", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 626, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 623, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 624, + "name": "new ProductType", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 625, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 622, + "name": "ProductType", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 627, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 628, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 629, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/payloads.ts", + "qualifiedName": "AdminCreateProductType" + }, + "name": "AdminCreateProductType", + "package": "@medusajs/types" + } + }, + { + "id": 630, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 631, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/responses.ts", + "qualifiedName": "AdminProductTypeResponse" + }, + "name": "AdminProductTypeResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 632, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 633, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 634, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 635, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/payloads.ts", + "qualifiedName": "AdminUpdateProductType" + }, + "name": "AdminUpdateProductType", + "package": "@medusajs/types" + } + }, + { + "id": 636, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 637, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/responses.ts", + "qualifiedName": "AdminProductTypeResponse" + }, + "name": "AdminProductTypeResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 638, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 639, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 640, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/queries.ts", + "qualifiedName": "AdminProductTypeListParams" + }, + "name": "AdminProductTypeListParams", + "package": "@medusajs/types" + } + }, + { + "id": 641, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/responses.ts", + "qualifiedName": "AdminProductTypeListResponse" + }, + "name": "AdminProductTypeListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 642, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 643, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 644, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 645, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/queries.ts", + "qualifiedName": "AdminProductTypeParams" + }, + "name": "AdminProductTypeParams", + "package": "@medusajs/types" + } + }, + { + "id": 646, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/responses.ts", + "qualifiedName": "AdminProductTypeResponse" + }, + "name": "AdminProductTypeResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 647, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 648, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 649, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 650, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-type/admin/responses.ts", + "qualifiedName": "AdminProductTypeDeleteResponse" + }, + "name": "AdminProductTypeDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 623 + ] + }, + { + "title": "Properties", + "children": [ + 626 + ] + }, + { + "title": "Methods", + "children": [ + 627, + 632, + 638, + 642, + 647 + ] + } + ] + }, + { + "id": 1693, + "name": "ProductVariant", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1697, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1694, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1695, + "name": "new ProductVariant", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1696, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1693, + "name": "ProductVariant", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1698, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1699, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1700, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/queries.ts", + "qualifiedName": "AdminProductVariantParams" + }, + "name": "AdminProductVariantParams", + "package": "@medusajs/types" + } + }, + { + "id": 1701, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductVariantListResponse" + }, + "name": "AdminProductVariantListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1694 + ] + }, + { + "title": "Properties", + "children": [ + 1697 + ] + }, + { + "title": "Methods", + "children": [ + 1698 + ] + } + ] + }, + { + "id": 500, + "name": "Product", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 504, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 501, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 502, + "name": "new Product", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 503, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 500, + "name": "Product", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 505, + "name": "import", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 506, + "name": "import", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 507, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminImportProductRequest" + }, + "name": "AdminImportProductRequest", + "package": "@medusajs/types" + } + }, + { + "id": 508, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 509, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + } + }, + { + "id": 510, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminImportProductResponse" + }, + "name": "AdminImportProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 511, + "name": "confirmImport", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 512, + "name": "confirmImport", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 513, + "name": "transactionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 514, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 515, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + } + }, + { + "id": 516, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 517, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 518, + "name": "export", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 519, + "name": "export", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 520, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminExportProductRequest" + }, + "name": "AdminExportProductRequest", + "package": "@medusajs/types" + } + }, + { + "id": 521, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/queries.ts", + "qualifiedName": "AdminProductListParams" + }, + "name": "AdminProductListParams", + "package": "@medusajs/types" + } + }, + { + "id": 522, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminExportProductResponse" + }, + "name": "AdminExportProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 523, + "name": "batch", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 524, + "name": "batch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 525, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminBatchProductRequest" + }, + "name": "AdminBatchProductRequest", + "package": "@medusajs/types" + } + }, + { + "id": 526, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 527, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminBatchProductResponse" + }, + "name": "AdminBatchProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 528, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 529, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 530, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminCreateProduct" + }, + "name": "AdminCreateProduct", + "package": "@medusajs/types" + } + }, + { + "id": 531, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 532, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 533, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 534, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 535, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 536, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminUpdateProduct" + }, + "name": "AdminUpdateProduct", + "package": "@medusajs/types" + } + }, + { + "id": 537, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 538, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 539, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 540, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 541, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/queries.ts", + "qualifiedName": "AdminProductListParams" + }, + "name": "AdminProductListParams", + "package": "@medusajs/types" + } + }, + { + "id": 542, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductListResponse" + }, + "name": "AdminProductListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 543, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 544, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 545, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 546, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 547, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 548, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 549, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 550, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 551, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductDeleteResponse" + }, + "name": "AdminProductDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 552, + "name": "batchVariants", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 553, + "name": "batchVariants", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 554, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 555, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminBatchProductVariantRequest" + }, + "name": "AdminBatchProductVariantRequest", + "package": "@medusajs/types" + } + }, + { + "id": 556, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 557, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminBatchProductVariantResponse" + }, + "name": "AdminBatchProductVariantResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 558, + "name": "createVariant", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 559, + "name": "createVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 560, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 561, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminCreateProductVariant" + }, + "name": "AdminCreateProductVariant", + "package": "@medusajs/types" + } + }, + { + "id": 562, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 563, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 564, + "name": "updateVariant", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 565, + "name": "updateVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 566, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 567, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 568, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminUpdateProductVariant" + }, + "name": "AdminUpdateProductVariant", + "package": "@medusajs/types" + } + }, + { + "id": 569, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 570, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 571, + "name": "listVariants", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 572, + "name": "listVariants", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 573, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 574, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/queries.ts", + "qualifiedName": "AdminProductVariantParams" + }, + "name": "AdminProductVariantParams", + "package": "@medusajs/types" + } + }, + { + "id": 575, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductVariantListResponse" + }, + "name": "AdminProductVariantListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 576, + "name": "retrieveVariant", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 577, + "name": "retrieveVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 578, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 579, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 580, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 581, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductVariantResponse" + }, + "name": "AdminProductVariantResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 582, + "name": "deleteVariant", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 583, + "name": "deleteVariant", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 584, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 585, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 586, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductVariantDeleteResponse" + }, + "name": "AdminProductVariantDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 587, + "name": "batchVariantInventoryItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 588, + "name": "batchVariantInventoryItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 589, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 590, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminBatchProductVariantInventoryItemRequest" + }, + "name": "AdminBatchProductVariantInventoryItemRequest", + "package": "@medusajs/types" + } + }, + { + "id": 591, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 592, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminBatchProductVariantInventoryItemResponse" + }, + "name": "AdminBatchProductVariantInventoryItemResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 593, + "name": "createOption", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 594, + "name": "createOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 595, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 596, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminCreateProductOption" + }, + "name": "AdminCreateProductOption", + "package": "@medusajs/types" + } + }, + { + "id": 597, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 598, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 599, + "name": "updateOption", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 600, + "name": "updateOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 601, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 602, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 603, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/payloads.ts", + "qualifiedName": "AdminUpdateProductOption" + }, + "name": "AdminUpdateProductOption", + "package": "@medusajs/types" + } + }, + { + "id": 604, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 605, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductResponse" + }, + "name": "AdminProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 606, + "name": "listOptions", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 607, + "name": "listOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 608, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 609, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/queries.ts", + "qualifiedName": "AdminProductOptionParams" + }, + "name": "AdminProductOptionParams", + "package": "@medusajs/types" + } + }, + { + "id": 610, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductOptionListResponse" + }, + "name": "AdminProductOptionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 611, + "name": "retrieveOption", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 612, + "name": "retrieveOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 613, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 614, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 615, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 616, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductOptionResponse" + }, + "name": "AdminProductOptionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 617, + "name": "deleteOption", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 618, + "name": "deleteOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 619, + "name": "productId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 620, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 621, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/admin/responses.ts", + "qualifiedName": "AdminProductOptionDeleteResponse" + }, + "name": "AdminProductOptionDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 501 + ] + }, + { + "title": "Properties", + "children": [ + 504 + ] + }, + { + "title": "Methods", + "children": [ + 505, + 511, + 518, + 523, + 528, + 533, + 539, + 543, + 548, + 552, + 558, + 564, + 571, + 576, + 582, + 587, + 593, + 599, + 606, + 611, + 617 + ] + } + ] + }, + { + "id": 1853, + "name": "Promotion", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1857, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1854, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1855, + "name": "new Promotion", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1856, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1853, + "name": "Promotion", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1858, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1859, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1860, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1861, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/queries.ts", + "qualifiedName": "AdminGetPromotionParams" + }, + "name": "AdminGetPromotionParams", + "package": "@medusajs/types" + } + }, + { + "id": 1862, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionResponse" + }, + "name": "AdminPromotionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1863, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1864, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1865, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/queries.ts", + "qualifiedName": "AdminGetPromotionsParams" + }, + "name": "AdminGetPromotionsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1866, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionListResponse" + }, + "name": "AdminPromotionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1867, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1868, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1869, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/payloads.ts", + "qualifiedName": "AdminCreatePromotion" + }, + "name": "AdminCreatePromotion", + "package": "@medusajs/types" + } + }, + { + "id": 1870, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionResponse" + }, + "name": "AdminPromotionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1871, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1872, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1873, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1874, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/payloads.ts", + "qualifiedName": "AdminUpdatePromotion" + }, + "name": "AdminUpdatePromotion", + "package": "@medusajs/types" + } + }, + { + "id": 1875, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionResponse" + }, + "name": "AdminPromotionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1876, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1877, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1878, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1879, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "DeleteResponse" + }, + "typeArguments": [ + { + "type": "literal", + "value": "promotion" + } + ], + "name": "DeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1880, + "name": "addRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1881, + "name": "addRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1882, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1883, + "name": "ruleType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1884, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/payloads.ts", + "qualifiedName": "BatchAddPromotionRulesReq" + }, + "name": "BatchAddPromotionRulesReq", + "package": "@medusajs/types" + } + }, + { + "id": 1885, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionResponse" + }, + "name": "AdminPromotionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1886, + "name": "updateRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1887, + "name": "updateRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1888, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1889, + "name": "ruleType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1890, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/payloads.ts", + "qualifiedName": "BatchUpdatePromotionRulesReq" + }, + "name": "BatchUpdatePromotionRulesReq", + "package": "@medusajs/types" + } + }, + { + "id": 1891, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionResponse" + }, + "name": "AdminPromotionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1892, + "name": "removeRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1893, + "name": "removeRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1894, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1895, + "name": "ruleType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1896, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/payloads.ts", + "qualifiedName": "BatchRemovePromotionRulesReq" + }, + "name": "BatchRemovePromotionRulesReq", + "package": "@medusajs/types" + } + }, + { + "id": 1897, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminPromotionResponse" + }, + "name": "AdminPromotionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1898, + "name": "listRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1899, + "name": "listRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1900, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1901, + "name": "ruleType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1902, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/queries.ts", + "qualifiedName": "AdminGetPromotionRuleParams" + }, + "name": "AdminGetPromotionRuleParams", + "package": "@medusajs/types" + } + }, + { + "id": 1903, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminRuleAttributeOptionsListResponse" + }, + "name": "AdminRuleAttributeOptionsListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1904, + "name": "listRuleAttributes", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1905, + "name": "listRuleAttributes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1906, + "name": "ruleType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1907, + "name": "promotionType", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1908, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminRuleAttributeOptionsListResponse" + }, + "name": "AdminRuleAttributeOptionsListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1909, + "name": "listRuleValues", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1910, + "name": "listRuleValues", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1911, + "name": "ruleType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1912, + "name": "ruleValue", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1913, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/queries.ts", + "qualifiedName": "AdminGetPromotionsRuleValueParams" + }, + "name": "AdminGetPromotionsRuleValueParams", + "package": "@medusajs/types" + } + }, + { + "id": 1914, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/promotion/admin/responses.ts", + "qualifiedName": "AdminRuleValueOptionsListResponse" + }, + "name": "AdminRuleValueOptionsListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1854 + ] + }, + { + "title": "Properties", + "children": [ + 1857 + ] + }, + { + "title": "Methods", + "children": [ + 1858, + 1863, + 1867, + 1871, + 1876, + 1880, + 1886, + 1892, + 1898, + 1904, + 1909 + ] + } + ] + }, + { + "id": 1702, + "name": "RefundReason", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1706, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1703, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1704, + "name": "new RefundReason", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1705, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1702, + "name": "RefundReason", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1707, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1708, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1709, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/queries.ts", + "qualifiedName": "RefundReasonFilters" + }, + "name": "RefundReasonFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1710, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/admin/responses.ts", + "qualifiedName": "RefundReasonsResponse" + }, + "name": "RefundReasonsResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1703 + ] + }, + { + "title": "Properties", + "children": [ + 1706 + ] + }, + { + "title": "Methods", + "children": [ + 1707 + ] + } + ] + }, + { + "id": 674, + "name": "Region", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 678, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 675, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 676, + "name": "new Region", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 677, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 674, + "name": "Region", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 679, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 680, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 681, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/payloads.ts", + "qualifiedName": "AdminCreateRegion" + }, + "name": "AdminCreateRegion", + "package": "@medusajs/types" + } + }, + { + "id": 682, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 683, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 684, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 685, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/entities.ts", + "qualifiedName": "AdminRegion" + }, + "name": "AdminRegion", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 685 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 686, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 687, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 688, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 689, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/payloads.ts", + "qualifiedName": "AdminUpdateRegion" + }, + "name": "AdminUpdateRegion", + "package": "@medusajs/types" + } + }, + { + "id": 690, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 691, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 692, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 693, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/entities.ts", + "qualifiedName": "AdminRegion" + }, + "name": "AdminRegion", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 693 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 694, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 695, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 696, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/queries.ts", + "qualifiedName": "AdminRegionFilters" + }, + "name": "AdminRegionFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 697, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/response.ts", + "qualifiedName": "PaginatedResponse" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 698, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 699, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/entities.ts", + "qualifiedName": "AdminRegion" + }, + "name": "AdminRegion", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 699 + ] + } + ] + } + } + ], + "name": "PaginatedResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 700, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 701, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 702, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 703, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 704, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 705, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 706, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/entities.ts", + "qualifiedName": "AdminRegion" + }, + "name": "AdminRegion", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 706 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 707, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 708, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 709, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 710, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/admin/responses.ts", + "qualifiedName": "AdminRegionDeleteResponse" + }, + "name": "AdminRegionDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 675 + ] + }, + { + "title": "Properties", + "children": [ + 678 + ] + }, + { + "title": "Methods", + "children": [ + 679, + 686, + 694, + 700, + 707 + ] + } + ] + }, + { + "id": 1790, + "name": "Reservation", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1794, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1791, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1792, + "name": "new Reservation", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1793, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1790, + "name": "Reservation", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1795, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1796, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1797, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1798, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/queries.ts", + "qualifiedName": "AdminReservationParams" + }, + "name": "AdminReservationParams", + "package": "@medusajs/types" + } + }, + { + "id": 1799, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/responses.ts", + "qualifiedName": "AdminReservationResponse" + }, + "name": "AdminReservationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1800, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1801, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1802, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/queries.ts", + "qualifiedName": "AdminGetReservationsParams" + }, + "name": "AdminGetReservationsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1803, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/responses.ts", + "qualifiedName": "AdminReservationListResponse" + }, + "name": "AdminReservationListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1804, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1805, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1806, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/payloads.ts", + "qualifiedName": "AdminCreateReservation" + }, + "name": "AdminCreateReservation", + "package": "@medusajs/types" + } + }, + { + "id": 1807, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/queries.ts", + "qualifiedName": "AdminGetReservationsParams" + }, + "name": "AdminGetReservationsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1808, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/responses.ts", + "qualifiedName": "AdminReservationResponse" + }, + "name": "AdminReservationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1809, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1810, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1811, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1812, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/payloads.ts", + "qualifiedName": "AdminUpdateReservation" + }, + "name": "AdminUpdateReservation", + "package": "@medusajs/types" + } + }, + { + "id": 1813, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/queries.ts", + "qualifiedName": "AdminGetReservationsParams" + }, + "name": "AdminGetReservationsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1814, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/responses.ts", + "qualifiedName": "AdminReservationResponse" + }, + "name": "AdminReservationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1815, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1816, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1817, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1818, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/reservation/admin/responses.ts", + "qualifiedName": "AdminReservationDeleteResponse" + }, + "name": "AdminReservationDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1791 + ] + }, + { + "title": "Properties", + "children": [ + 1794 + ] + }, + { + "title": "Methods", + "children": [ + 1795, + 1800, + 1804, + 1809, + 1815 + ] + } + ] + }, + { + "id": 711, + "name": "ReturnReason", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 715, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 712, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 713, + "name": "new ReturnReason", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 714, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 711, + "name": "ReturnReason", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 716, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 717, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 718, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/queries.ts", + "qualifiedName": "AdminReturnReasonListParams" + }, + "name": "AdminReturnReasonListParams", + "package": "@medusajs/types" + } + }, + { + "id": 719, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/responses.ts", + "qualifiedName": "AdminReturnReasonListResponse" + }, + "name": "AdminReturnReasonListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 720, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 721, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 722, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 723, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/queries.ts", + "qualifiedName": "AdminReturnReasonParams" + }, + "name": "AdminReturnReasonParams", + "package": "@medusajs/types" + } + }, + { + "id": 724, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/responses.ts", + "qualifiedName": "AdminReturnReasonResponse" + }, + "name": "AdminReturnReasonResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 725, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 726, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 727, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/payloads.ts", + "qualifiedName": "AdminCreateReturnReason" + }, + "name": "AdminCreateReturnReason", + "package": "@medusajs/types" + } + }, + { + "id": 728, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/queries.ts", + "qualifiedName": "AdminReturnReasonParams" + }, + "name": "AdminReturnReasonParams", + "package": "@medusajs/types" + } + }, + { + "id": 729, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/responses.ts", + "qualifiedName": "AdminReturnReasonResponse" + }, + "name": "AdminReturnReasonResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 730, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 731, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 732, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 733, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/payloads.ts", + "qualifiedName": "AdminUpdateReturnReason" + }, + "name": "AdminUpdateReturnReason", + "package": "@medusajs/types" + } + }, + { + "id": 734, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/queries.ts", + "qualifiedName": "AdminReturnReasonParams" + }, + "name": "AdminReturnReasonParams", + "package": "@medusajs/types" + } + }, + { + "id": 735, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/responses.ts", + "qualifiedName": "AdminReturnReasonResponse" + }, + "name": "AdminReturnReasonResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 736, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 737, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 738, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 739, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/queries.ts", + "qualifiedName": "AdminReturnReasonParams" + }, + "name": "AdminReturnReasonParams", + "package": "@medusajs/types" + } + }, + { + "id": 740, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return-reason/admin/responses.ts", + "qualifiedName": "AdminReturnReasonDeleteResponse" + }, + "name": "AdminReturnReasonDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 712 + ] + }, + { + "title": "Properties", + "children": [ + 715 + ] + }, + { + "title": "Methods", + "children": [ + 716, + 720, + 725, + 730, + 736 + ] + } + ] + }, + { + "id": 1140, + "name": "Return", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1144, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1141, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1142, + "name": "new Return", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1143, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1140, + "name": "Return", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1145, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1146, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1147, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/queries.ts", + "qualifiedName": "AdminReturnFilters" + }, + "name": "AdminReturnFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1148, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnsResponse" + }, + "name": "AdminReturnsResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1149, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1150, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1151, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1152, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1153, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1154, + "name": "initiateRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1155, + "name": "initiateRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1156, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminInitiateReturnRequest" + }, + "name": "AdminInitiateReturnRequest", + "package": "@medusajs/types" + } + }, + { + "id": 1157, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1158, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1159, + "name": "cancel", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1160, + "name": "cancel", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1161, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1162, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1163, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1164, + "name": "cancelRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1165, + "name": "cancelRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1166, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1167, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1168, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1169, + "name": "addReturnItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1170, + "name": "addReturnItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1171, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1172, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminAddReturnItems" + }, + "name": "AdminAddReturnItems", + "package": "@medusajs/types" + } + }, + { + "id": 1173, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1174, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1175, + "name": "updateReturnItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1176, + "name": "updateReturnItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1177, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1178, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1179, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminUpdateReturnItems" + }, + "name": "AdminUpdateReturnItems", + "package": "@medusajs/types" + } + }, + { + "id": 1180, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1181, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1182, + "name": "removeReturnItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1183, + "name": "removeReturnItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1184, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1185, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1186, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1187, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1188, + "name": "addReturnShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1189, + "name": "addReturnShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1190, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1191, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminAddReturnShipping" + }, + "name": "AdminAddReturnShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1192, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1193, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1194, + "name": "updateReturnShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1195, + "name": "updateReturnShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1196, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1197, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1198, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminAddReturnShipping" + }, + "name": "AdminAddReturnShipping", + "package": "@medusajs/types" + } + }, + { + "id": 1199, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1200, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1201, + "name": "deleteReturnShipping", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1202, + "name": "deleteReturnShipping", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1203, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1204, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1205, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1206, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1207, + "name": "updateRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1208, + "name": "updateRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1209, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1210, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminUpdateReturnRequest" + }, + "name": "AdminUpdateReturnRequest", + "package": "@medusajs/types" + } + }, + { + "id": 1211, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1212, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1213, + "name": "confirmRequest", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1214, + "name": "confirmRequest", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1215, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1216, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminConfirmReturnRequest" + }, + "name": "AdminConfirmReturnRequest", + "package": "@medusajs/types" + } + }, + { + "id": 1217, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1218, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1219, + "name": "initiateReceive", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1220, + "name": "initiateReceive", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1221, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1222, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminInitiateReceiveReturn" + }, + "name": "AdminInitiateReceiveReturn", + "package": "@medusajs/types" + } + }, + { + "id": 1223, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1224, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1225, + "name": "receiveItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1226, + "name": "receiveItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1227, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1228, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminReceiveItems" + }, + "name": "AdminReceiveItems", + "package": "@medusajs/types" + } + }, + { + "id": 1229, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1230, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1231, + "name": "updateReceiveItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1232, + "name": "updateReceiveItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1233, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1234, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1235, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminUpdateReceiveItems" + }, + "name": "AdminUpdateReceiveItems", + "package": "@medusajs/types" + } + }, + { + "id": 1236, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1237, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1238, + "name": "removeReceiveItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1239, + "name": "removeReceiveItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1240, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1241, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1242, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1243, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1244, + "name": "dismissItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1245, + "name": "dismissItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1246, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1247, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminDismissItems" + }, + "name": "AdminDismissItems", + "package": "@medusajs/types" + } + }, + { + "id": 1248, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1249, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1250, + "name": "updateDismissItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1251, + "name": "updateDismissItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1252, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1253, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1254, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminUpdateDismissItems" + }, + "name": "AdminUpdateDismissItems", + "package": "@medusajs/types" + } + }, + { + "id": 1255, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1256, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1257, + "name": "removeDismissItem", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1258, + "name": "removeDismissItem", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1259, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1260, + "name": "actionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1261, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1262, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1263, + "name": "confirmReceive", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1264, + "name": "confirmReceive", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1265, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1266, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/payloads.ts", + "qualifiedName": "AdminConfirmReceiveReturn" + }, + "name": "AdminConfirmReceiveReturn", + "package": "@medusajs/types" + } + }, + { + "id": 1267, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1268, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1269, + "name": "cancelReceive", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1270, + "name": "cancelReceive", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1271, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1272, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1273, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/return/admin/responses.ts", + "qualifiedName": "AdminReturnResponse" + }, + "name": "AdminReturnResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1141 + ] + }, + { + "title": "Properties", + "children": [ + 1144 + ] + }, + { + "title": "Methods", + "children": [ + 1145, + 1149, + 1154, + 1159, + 1164, + 1169, + 1175, + 1182, + 1188, + 1194, + 1201, + 1207, + 1213, + 1219, + 1225, + 1231, + 1238, + 1244, + 1250, + 1257, + 1263, + 1269 + ] + } + ] + }, + { + "id": 785, + "name": "SalesChannel", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 789, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 786, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 787, + "name": "new SalesChannel", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 788, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 785, + "name": "SalesChannel", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 790, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 791, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 792, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/payloads.ts", + "qualifiedName": "AdminCreateSalesChannel" + }, + "name": "AdminCreateSalesChannel", + "package": "@medusajs/types" + } + }, + { + "id": 793, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 794, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelResponse" + }, + "name": "AdminSalesChannelResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 795, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 796, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 797, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 798, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/payloads.ts", + "qualifiedName": "AdminUpdateSalesChannel" + }, + "name": "AdminUpdateSalesChannel", + "package": "@medusajs/types" + } + }, + { + "id": 799, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 800, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelResponse" + }, + "name": "AdminSalesChannelResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 801, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 802, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 803, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 804, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelDeleteResponse" + }, + "name": "AdminSalesChannelDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 805, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 806, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 807, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 808, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 809, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelResponse" + }, + "name": "AdminSalesChannelResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 810, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 811, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 812, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/queries.ts", + "qualifiedName": "AdminSalesChannelListParams" + }, + "name": "AdminSalesChannelListParams", + "package": "@medusajs/types" + } + }, + { + "id": 813, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelListResponse" + }, + "name": "AdminSalesChannelListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 814, + "name": "updateProducts", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 815, + "name": "updateProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 816, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/payloads.ts", + "qualifiedName": "AdminUpdateSalesChannelProducts" + }, + "name": "AdminUpdateSalesChannelProducts", + "package": "@medusajs/types" + } + }, + { + "id": 818, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelResponse" + }, + "name": "AdminSalesChannelResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 819, + "name": "batchProducts", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 820, + "name": "batchProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 821, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 822, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "AdminBatchLink" + }, + "name": "AdminBatchLink", + "package": "@medusajs/types" + } + }, + { + "id": 823, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/sales-channel/admin/responses.ts", + "qualifiedName": "AdminSalesChannelResponse" + }, + "name": "AdminSalesChannelResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 786 + ] + }, + { + "title": "Properties", + "children": [ + 789 + ] + }, + { + "title": "Methods", + "children": [ + 790, + 795, + 801, + 805, + 810, + 814, + 819 + ] + } + ] + }, + { + "id": 887, + "name": "ShippingOption", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 891, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 888, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 889, + "name": "new ShippingOption", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 890, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 887, + "name": "ShippingOption", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 892, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 893, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 894, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/payloads.ts", + "qualifiedName": "AdminCreateShippingOption" + }, + "name": "AdminCreateShippingOption", + "package": "@medusajs/types" + } + }, + { + "id": 895, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 896, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/responses.ts", + "qualifiedName": "AdminShippingOptionResponse" + }, + "name": "AdminShippingOptionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 897, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 898, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 899, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 900, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 901, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/responses.ts", + "qualifiedName": "AdminShippingOptionResponse" + }, + "name": "AdminShippingOptionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 902, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 903, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 904, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 905, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/payloads.ts", + "qualifiedName": "AdminUpdateShippingOption" + }, + "name": "AdminUpdateShippingOption", + "package": "@medusajs/types" + } + }, + { + "id": 906, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 907, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/responses.ts", + "qualifiedName": "AdminShippingOptionResponse" + }, + "name": "AdminShippingOptionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 908, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 909, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 910, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 911, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/responses.ts", + "qualifiedName": "AdminShippingOptionDeleteResponse" + }, + "name": "AdminShippingOptionDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 912, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 913, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 914, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/queries.ts", + "qualifiedName": "AdminShippingOptionListParams" + }, + "name": "AdminShippingOptionListParams", + "package": "@medusajs/types" + } + }, + { + "id": 915, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/responses.ts", + "qualifiedName": "AdminShippingOptionListResponse" + }, + "name": "AdminShippingOptionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 916, + "name": "updateRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 917, + "name": "updateRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 918, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 919, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/payloads.ts", + "qualifiedName": "AdminUpdateShippingOptionRules" + }, + "name": "AdminUpdateShippingOptionRules", + "package": "@medusajs/types" + } + }, + { + "id": 920, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/admin/responses.ts", + "qualifiedName": "AdminUpdateShippingOptionRulesResponse" + }, + "name": "AdminUpdateShippingOptionRulesResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 888 + ] + }, + { + "title": "Properties", + "children": [ + 891 + ] + }, + { + "title": "Methods", + "children": [ + 892, + 897, + 902, + 908, + 912, + 916 + ] + } + ] + }, + { + "id": 921, + "name": "ShippingProfile", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 925, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 922, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 923, + "name": "new ShippingProfile", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 924, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 921, + "name": "ShippingProfile", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 926, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 927, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 928, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/payloads.ts", + "qualifiedName": "AdminCreateShippingProfile" + }, + "name": "AdminCreateShippingProfile", + "package": "@medusajs/types" + } + }, + { + "id": 929, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 930, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/responses.ts", + "qualifiedName": "AdminShippingProfileResponse" + }, + "name": "AdminShippingProfileResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 931, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 932, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 933, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 934, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/payloads.ts", + "qualifiedName": "AdminUpdateShippingProfile" + }, + "name": "AdminUpdateShippingProfile", + "package": "@medusajs/types" + } + }, + { + "id": 935, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 936, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/responses.ts", + "qualifiedName": "AdminShippingProfileResponse" + }, + "name": "AdminShippingProfileResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 937, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 938, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 939, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 940, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/responses.ts", + "qualifiedName": "AdminShippingProfileDeleteResponse" + }, + "name": "AdminShippingProfileDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 941, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 942, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 943, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/queries.ts", + "qualifiedName": "AdminShippingProfileListParams" + }, + "name": "AdminShippingProfileListParams", + "package": "@medusajs/types" + } + }, + { + "id": 944, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/responses.ts", + "qualifiedName": "AdminShippingProfileListResponse" + }, + "name": "AdminShippingProfileListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 945, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 946, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 947, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 948, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 949, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-profile/admin/responses.ts", + "qualifiedName": "AdminShippingProfileResponse" + }, + "name": "AdminShippingProfileResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 922 + ] + }, + { + "title": "Properties", + "children": [ + 925 + ] + }, + { + "title": "Methods", + "children": [ + 926, + 931, + 937, + 941, + 945 + ] + } + ] + }, + { + "id": 741, + "name": "StockLocation", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 745, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 742, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 743, + "name": "new StockLocation", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 744, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 741, + "name": "StockLocation", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 746, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 747, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 748, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/payloads.ts", + "qualifiedName": "AdminCreateStockLocation" + }, + "name": "AdminCreateStockLocation", + "package": "@medusajs/types" + } + }, + { + "id": 749, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 750, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationResponse" + }, + "name": "AdminStockLocationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 751, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 752, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 753, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 754, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/payloads.ts", + "qualifiedName": "AdminUpdateStockLocation" + }, + "name": "AdminUpdateStockLocation", + "package": "@medusajs/types" + } + }, + { + "id": 755, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 756, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationResponse" + }, + "name": "AdminStockLocationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 757, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 758, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 759, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 760, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationDeleteResponse" + }, + "name": "AdminStockLocationDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 761, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 762, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 763, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 764, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 765, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationResponse" + }, + "name": "AdminStockLocationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 766, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 767, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 768, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/queries.ts", + "qualifiedName": "AdminStockLocationListParams" + }, + "name": "AdminStockLocationListParams", + "package": "@medusajs/types" + } + }, + { + "id": 769, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationListResponse" + }, + "name": "AdminStockLocationListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 770, + "name": "updateSalesChannels", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 771, + "name": "updateSalesChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 772, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 773, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/payloads.ts", + "qualifiedName": "AdminUpdateStockLocationSalesChannels" + }, + "name": "AdminUpdateStockLocationSalesChannels", + "package": "@medusajs/types" + } + }, + { + "id": 774, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationResponse" + }, + "name": "AdminStockLocationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 775, + "name": "createFulfillmentSet", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 776, + "name": "createFulfillmentSet", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 777, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/payloads.ts", + "qualifiedName": "AdminCreateStockLocationFulfillmentSet" + }, + "name": "AdminCreateStockLocationFulfillmentSet", + "package": "@medusajs/types" + } + }, + { + "id": 779, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationResponse" + }, + "name": "AdminStockLocationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 780, + "name": "updateFulfillmentProviders", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 781, + "name": "updateFulfillmentProviders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 782, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 783, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "AdminBatchLink" + }, + "name": "AdminBatchLink", + "package": "@medusajs/types" + } + }, + { + "id": 784, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/stock-locations/admin/responses.ts", + "qualifiedName": "AdminStockLocationResponse" + }, + "name": "AdminStockLocationResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 742 + ] + }, + { + "title": "Properties", + "children": [ + 745 + ] + }, + { + "title": "Methods", + "children": [ + 746, + 751, + 757, + 761, + 766, + 770, + 775, + 780 + ] + } + ] + }, + { + "id": 1567, + "name": "Store", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1571, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1568, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1569, + "name": "new Store", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1570, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1567, + "name": "Store", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1572, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1573, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1574, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1575, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/store/admin/queries.ts", + "qualifiedName": "AdminStoreParams" + }, + "name": "AdminStoreParams", + "package": "@medusajs/types" + } + }, + { + "id": 1576, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/store/admin/responses.ts", + "qualifiedName": "AdminStoreResponse" + }, + "name": "AdminStoreResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1577, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1578, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1579, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/store/admin/queries.ts", + "qualifiedName": "AdminStoreListParams" + }, + "name": "AdminStoreListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1580, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/store/admin/responses.ts", + "qualifiedName": "AdminStoreListResponse" + }, + "name": "AdminStoreListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1581, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1582, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1583, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1584, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/store/admin/payloads.ts", + "qualifiedName": "AdminUpdateStore" + }, + "name": "AdminUpdateStore", + "package": "@medusajs/types" + } + }, + { + "id": 1585, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1586, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/store/admin/responses.ts", + "qualifiedName": "AdminStoreResponse" + }, + "name": "AdminStoreResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1568 + ] + }, + { + "title": "Properties", + "children": [ + 1571 + ] + }, + { + "title": "Methods", + "children": [ + 1572, + 1577, + 1581 + ] + } + ] + }, + { + "id": 1515, + "name": "TaxRate", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1519, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1516, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1517, + "name": "new TaxRate", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1518, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1515, + "name": "TaxRate", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1520, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1521, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1522, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/payloads.ts", + "qualifiedName": "AdminCreateTaxRate" + }, + "name": "AdminCreateTaxRate", + "package": "@medusajs/types" + } + }, + { + "id": 1523, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1524, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/responses.ts", + "qualifiedName": "AdminTaxRateResponse" + }, + "name": "AdminTaxRateResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1525, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1526, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1527, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1528, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/payloads.ts", + "qualifiedName": "AdminUpdateTaxRate" + }, + "name": "AdminUpdateTaxRate", + "package": "@medusajs/types" + } + }, + { + "id": 1529, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1530, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/responses.ts", + "qualifiedName": "AdminTaxRateResponse" + }, + "name": "AdminTaxRateResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1531, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1532, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1533, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1534, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/responses.ts", + "qualifiedName": "AdminTaxRateDeleteResponse" + }, + "name": "AdminTaxRateDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1535, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1536, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1537, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1538, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1539, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/responses.ts", + "qualifiedName": "AdminTaxRateResponse" + }, + "name": "AdminTaxRateResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1540, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1541, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1542, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/queries.ts", + "qualifiedName": "AdminTaxRateListParams" + }, + "name": "AdminTaxRateListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1543, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-rate/admin/responses.ts", + "qualifiedName": "AdminTaxRateListResponse" + }, + "name": "AdminTaxRateListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1516 + ] + }, + { + "title": "Properties", + "children": [ + 1519 + ] + }, + { + "title": "Methods", + "children": [ + 1520, + 1525, + 1531, + 1535, + 1540 + ] + } + ] + }, + { + "id": 1544, + "name": "TaxRegion", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1548, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1545, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1546, + "name": "new TaxRegion", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1547, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1544, + "name": "TaxRegion", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1549, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1550, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1551, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-region/admin/payloads.ts", + "qualifiedName": "AdminCreateTaxRegion" + }, + "name": "AdminCreateTaxRegion", + "package": "@medusajs/types" + } + }, + { + "id": 1552, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1553, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-region/admin/responses.ts", + "qualifiedName": "AdminTaxRegionResponse" + }, + "name": "AdminTaxRegionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1554, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1555, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1556, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1557, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-region/admin/responses.ts", + "qualifiedName": "AdminTaxRegionDeleteResponse" + }, + "name": "AdminTaxRegionDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1558, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1559, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1560, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1561, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 1562, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-region/admin/responses.ts", + "qualifiedName": "AdminTaxRegionResponse" + }, + "name": "AdminTaxRegionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1563, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1564, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1565, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-region/admin/queries.ts", + "qualifiedName": "AdminTaxRegionListParams" + }, + "name": "AdminTaxRegionListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1566, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/tax-region/admin/responses.ts", + "qualifiedName": "AdminTaxRegionListResponse" + }, + "name": "AdminTaxRegionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1545 + ] + }, + { + "title": "Properties", + "children": [ + 1548 + ] + }, + { + "title": "Methods", + "children": [ + 1549, + 1554, + 1558, + 1563 + ] + } + ] + }, + { + "id": 651, + "name": "Upload", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 655, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 652, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 653, + "name": "new Upload", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 654, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 651, + "name": "Upload", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 656, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 657, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 658, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/file/common.ts", + "qualifiedName": "BaseUploadFile" + }, + "name": "BaseUploadFile", + "package": "@medusajs/types" + } + }, + { + "id": 659, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 660, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 661, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 662, + "name": "files", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/file/admin/entities.ts", + "qualifiedName": "AdminFile" + }, + "name": "AdminFile", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 662 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 663, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 664, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 665, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 666, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 667, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 668, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 669, + "name": "file", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/file/admin/entities.ts", + "qualifiedName": "AdminFile" + }, + "name": "AdminFile", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 669 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 670, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 671, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 672, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 673, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/file/admin/responses.ts", + "qualifiedName": "AdminFileDeleteResponse" + }, + "name": "AdminFileDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 652 + ] + }, + { + "title": "Properties", + "children": [ + 655 + ] + }, + { + "title": "Methods", + "children": [ + 656, + 663, + 670 + ] + } + ] + }, + { + "id": 1616, + "name": "User", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1620, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1617, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1618, + "name": "new User", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1619, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1616, + "name": "User", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1621, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1622, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1623, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/payloads.ts", + "qualifiedName": "AdminCreateUser" + }, + "name": "AdminCreateUser", + "package": "@medusajs/types" + } + }, + { + "id": 1624, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/queries.ts", + "qualifiedName": "AdminUserParams" + }, + "name": "AdminUserParams", + "package": "@medusajs/types" + } + }, + { + "id": 1625, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserResponse" + }, + "name": "AdminUserResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1626, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1627, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1628, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1629, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/payloads.ts", + "qualifiedName": "AdminUpdateUser" + }, + "name": "AdminUpdateUser", + "package": "@medusajs/types" + } + }, + { + "id": 1630, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/queries.ts", + "qualifiedName": "AdminUserParams" + }, + "name": "AdminUserParams", + "package": "@medusajs/types" + } + }, + { + "id": 1631, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserResponse" + }, + "name": "AdminUserResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1632, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1633, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1634, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/queries.ts", + "qualifiedName": "AdminUserListParams" + }, + "name": "AdminUserListParams", + "package": "@medusajs/types" + } + }, + { + "id": 1635, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserListResponse" + }, + "name": "AdminUserListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1636, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1637, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1638, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1639, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/queries.ts", + "qualifiedName": "AdminUserParams" + }, + "name": "AdminUserParams", + "package": "@medusajs/types" + } + }, + { + "id": 1640, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserResponse" + }, + "name": "AdminUserResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1641, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1642, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1643, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1644, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserDeleteResponse" + }, + "name": "AdminUserDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1645, + "name": "me", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1646, + "name": "me", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1647, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/queries.ts", + "qualifiedName": "AdminUserParams" + }, + "name": "AdminUserParams", + "package": "@medusajs/types" + } + }, + { + "id": 1648, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/user/admin/responses.ts", + "qualifiedName": "AdminUserResponse" + }, + "name": "AdminUserResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1617 + ] + }, + { + "title": "Properties", + "children": [ + 1620 + ] + }, + { + "title": "Methods", + "children": [ + 1621, + 1626, + 1632, + 1636, + 1641, + 1645 + ] + } + ] + }, + { + "id": 1777, + "name": "WorkflowExecution", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1781, + "name": "client", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1778, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1779, + "name": "new WorkflowExecution", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@ignore" + ] + }, + "parameters": [ + { + "id": 1780, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1777, + "name": "WorkflowExecution", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1782, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1783, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1784, + "name": "queryParams", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/workflow-execution/admin/queries.ts", + "qualifiedName": "AdminGetWorkflowExecutionsParams" + }, + "name": "AdminGetWorkflowExecutionsParams", + "package": "@medusajs/types" + } + }, + { + "id": 1785, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/workflow-execution/admin/responses.ts", + "qualifiedName": "AdminWorkflowExecutionListResponse" + }, + "name": "AdminWorkflowExecutionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1786, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1787, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1788, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1789, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/workflow-execution/admin/responses.ts", + "qualifiedName": "AdminWorkflowExecutionResponse" + }, + "name": "AdminWorkflowExecutionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1778 + ] + }, + { + "title": "Properties", + "children": [ + 1781 + ] + }, + { + "title": "Methods", + "children": [ + 1782, + 1786 + ] + } + ] + }, + { + "id": 1947, + "name": "Client", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1951, + "name": "fetch_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "target": 2015, + "name": "ClientFetch", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1952, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "type": { + "type": "reference", + "target": 2002, + "name": "Config", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1953, + "name": "logger", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "type": { + "type": "reference", + "target": 2020, + "name": "Logger", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 1954, + "name": "DEFAULT_JWT_STORAGE_KEY", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"medusa_auth_token\"" + }, + { + "id": 1955, + "name": "token", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"\"" + }, + { + "id": 1948, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1949, + "name": "new Client", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1950, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2002, + "name": "Config", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1956, + "name": "fetch", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1957, + "name": "fetch", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " closely follows (and uses under the hood) the native " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " API. There are, however, few key differences:\n- Non 2xx statuses throw a " + }, + { + "kind": "code", + "text": "`FetchError`" + }, + { + "kind": "text", + "text": " with the status code as the " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " property, rather than resolving the promise\n- You can pass " + }, + { + "kind": "code", + "text": "`body`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " as objects, and they will be encoded and stringified.\n- The response gets parsed as JSON if the " + }, + { + "kind": "code", + "text": "`accept`" + }, + { + "kind": "text", + "text": " header is set to " + }, + { + "kind": "code", + "text": "`application/json`" + }, + { + "kind": "text", + "text": ", otherwise the raw Response object is returned\n\nSince the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass " + }, + { + "kind": "code", + "text": "`Response`" + }, + { + "kind": "text", + "text": " as the return type" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Promise" + } + ] + } + ] + }, + "typeParameters": [ + { + "id": 1958, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 1959, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Request" + }, + "name": "Request", + "package": "typescript" + } + ] + } + }, + { + "id": 1960, + "name": "init", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2038, + "name": "FetchArgs", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1958, + "name": "T", + "package": "@medusajs/js-sdk", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1961, + "name": "fetchStream", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1962, + "name": "fetchStream", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "code", + "text": "`fetchStream`" + }, + { + "kind": "text", + "text": " is a helper method to deal with server-sent events. It returns an object with a stream and an abort function.\nIt follows a very similar interface to " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": ", with the return value being an async generator.\nThe stream is an async generator that yields " + }, + { + "kind": "code", + "text": "`ServerSentEventMessage`" + }, + { + "kind": "text", + "text": " objects, which contains the event name, stringified data, and few other properties.\nThe caller is responsible for handling " + }, + { + "kind": "code", + "text": "`disconnect`" + }, + { + "kind": "text", + "text": " events and aborting the stream. The caller is also responsible for parsing the data field." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "FetchStreamResponse" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1963, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Request" + }, + "name": "Request", + "package": "typescript" + } + ] + } + }, + { + "id": 1964, + "name": "init", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2038, + "name": "FetchArgs", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2043, + "name": "FetchStreamResponse", + "package": "@medusajs/js-sdk" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1965, + "name": "setToken", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1966, + "name": "setToken", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1967, + "name": "token", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 1968, + "name": "clearToken", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1969, + "name": "clearToken", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 1970, + "name": "clearToken_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1971, + "name": "clearToken_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 1972, + "name": "initClient", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1973, + "name": "initClient", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": 2015, + "name": "ClientFetch", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 1974, + "name": "getApiKeyHeader_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1975, + "name": "getApiKeyHeader_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1976, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + }, + { + "type": "reflection", + "declaration": { + "id": 1977, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1978, + "name": "Authorization", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1978 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1979, + "name": "getPublishableKeyHeader_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1980, + "name": "getPublishableKeyHeader_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1981, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + }, + { + "type": "reflection", + "declaration": { + "id": 1982, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1983, + "name": "x-publishable-api-key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1983 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1984, + "name": "getJwtHeader_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1985, + "name": "getJwtHeader_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1986, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + }, + { + "type": "reflection", + "declaration": { + "id": 1987, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1988, + "name": "Authorization", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1988 + ] + } + ] + } + } + ] + } + } + ] + }, + { + "id": 1989, + "name": "setToken_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1990, + "name": "setToken_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1991, + "name": "token", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 1992, + "name": "getToken_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1993, + "name": "getToken_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + }, + { + "id": 1994, + "name": "getTokenStorageInfo_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 1995, + "name": "getTokenStorageInfo_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1996, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1997, + "name": "storageMethod", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "session" + }, + { + "type": "literal", + "value": "local" + }, + { + "type": "literal", + "value": "memory" + }, + { + "type": "literal", + "value": "nostore" + } + ] + } + }, + { + "id": 1998, + "name": "storageKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1997, + 1998 + ] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1948 + ] + }, + { + "title": "Properties", + "children": [ + 1951, + 1952, + 1953, + 1954, + 1955 + ] + }, + { + "title": "Methods", + "children": [ + 1956, + 1961, + 1965, + 1968, + 1970, + 1972, + 1974, + 1979, + 1984, + 1989, + 1992, + 1994 + ] + } + ] + }, + { + "id": 2020, + "name": "Logger", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2021, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2022, + "name": "error", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2023, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2024, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2025, + "name": "messages", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 2026, + "name": "warn", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2027, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2028, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2029, + "name": "messages", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 2030, + "name": "info", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2031, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2032, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2033, + "name": "messages", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 2034, + "name": "debug", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2035, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2036, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2037, + "name": "messages", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2022, + 2026, + 2030, + 2034 + ] + } + ] + } + } + }, + { + "id": 2002, + "name": "Config", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2003, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2004, + "name": "baseUrl", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2005, + "name": "globalHeaders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 2006, + "name": "publishableKey", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2007, + "name": "apiKey", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2008, + "name": "auth", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2009, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2010, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "jwt" + }, + { + "type": "literal", + "value": "session" + } + ] + } + }, + { + "id": 2011, + "name": "jwtTokenStorageKey", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2012, + "name": "jwtTokenStorageMethod", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "local" + }, + { + "type": "literal", + "value": "session" + }, + { + "type": "literal", + "value": "memory" + }, + { + "type": "literal", + "value": "nostore" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2010, + 2011, + 2012 + ] + } + ] + } + } + }, + { + "id": 2013, + "name": "logger", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2020, + "name": "Logger", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 2014, + "name": "debug", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2004, + 2005, + 2006, + 2007, + 2008, + 2013, + 2014 + ] + } + ] + } + } + }, + { + "id": 2055, + "name": "FetchParams", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Parameters" + }, + "typeArguments": [ + { + "type": "query", + "queryType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "fetch" + }, + "name": "fetch", + "package": "typescript", + "preferValues": true + } + } + ], + "name": "Parameters", + "package": "typescript" + } + }, + { + "id": 1999, + "name": "ClientHeaders", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 2000, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2001, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag)." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2001 + ] + } + ] + } + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 2048, + "name": "FetchInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": 0 + }, + "objectType": { + "type": "reference", + "target": 2055, + "name": "FetchParams", + "package": "@medusajs/js-sdk" + } + } + }, + { + "id": 2038, + "name": "FetchArgs", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "headers" + }, + { + "type": "literal", + "value": "body" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2039, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2040, + "name": "query", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 2041, + "name": "headers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 2042, + "name": "body", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "body" + }, + "objectType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2040, + 2041, + 2042 + ] + } + ] + } + } + ] + } + }, + { + "id": 2015, + "name": "ClientFetch", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2016, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2017, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2018, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2048, + "name": "FetchInput", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 2019, + "name": "init", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2038, + "name": "FetchArgs", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2049, + "name": "ServerSentEventMessage", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2050, + "name": "comment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Ignored by the client." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2051, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A string identifying the type of event described." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2052, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data field for the message. Split by new lines." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2053, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The event ID to set the " + }, + { + "kind": "inline-tag", + "tag": "@linkcode", + "text": "EventSource", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventSource" + }, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " object's last event ID value." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 2054, + "name": "retry", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reconnection time." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2050, + 2051, + 2052, + 2053, + 2054 + ] + } + ] + }, + { + "id": 2043, + "name": "FetchStreamResponse", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2044, + "name": "stream", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts", + "qualifiedName": "AsyncGenerator" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2049, + "name": "ServerSentEventMessage", + "package": "@medusajs/js-sdk" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "AsyncGenerator", + "package": "typescript" + } + ] + } + }, + { + "id": 2045, + "name": "abort", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2046, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2047, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2044, + 2045 + ] + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 1740, + 1915, + 1274, + 1649, + 1819, + 332, + 1404, + 878, + 824, + 857, + 2, + 950, + 288, + 1002, + 1089, + 1016, + 1711, + 1663, + 430, + 471, + 395, + 361, + 1587, + 622, + 1693, + 500, + 1853, + 1702, + 674, + 1790, + 711, + 1140, + 785, + 887, + 921, + 741, + 1567, + 1515, + 1544, + 651, + 1616, + 1777, + 1947 + ] + }, + { + "title": "Interfaces", + "children": [ + 2049, + 2043 + ] + }, + { + "title": "Type Aliases", + "children": [ + 2020, + 2002, + 2055, + 1999, + 2048, + 2038, + 2015 + ] + } + ] + }, + { + "id": 47, + "name": "auth", + "variant": "declaration", + "kind": 2, + "flags": {}, + "children": [ + { + "id": 48, + "name": "Auth", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 49, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 50, + "name": "new Auth", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 51, + "name": "client", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1947, + "name": "Client", + "package": "@medusajs/js-sdk" + } + }, + { + "id": 52, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2002, + "name": "Config", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": 48, + "name": "Auth", + "package": "@medusajs/js-sdk" + } + } + ] + }, + { + "id": 55, + "name": "register", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 56, + "name": "register", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the\n[Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth_postactor_typeauth_provider_register)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The JWT token used for registration later." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth\n .register(\"customer\", \"emailpass\", {\n email: \"customer@gmail.com\",\n password: \"supersecret\",\n }\n .then((token) => {\n console.log(token)\n })\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 57, + "name": "actor", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor type. For example, " + }, + { + "kind": "code", + "text": "`user`" + }, + { + "kind": "text", + "text": " for admin user, or " + }, + { + "kind": "code", + "text": "`customer`" + }, + { + "kind": "text", + "text": " for customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 58, + "name": "method", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The authentication provider to use. For example, " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 59, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to pass in the request's body for authentication. When using the " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": " provider,\nyou pass the email and password." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/auth/payloads.ts", + "qualifiedName": "AdminSignUpWithEmailPassword" + }, + "name": "AdminSignUpWithEmailPassword", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 60, + "name": "login", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 61, + "name": "login", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves the JWT authenticated token for an admin user, customer, or custom\nactor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_provider).\n\nIf the " + }, + { + "kind": "code", + "text": "`auth.type`" + }, + { + "kind": "text", + "text": " of the SDK is set to " + }, + { + "kind": "code", + "text": "`session`" + }, + { + "kind": "text", + "text": ", this method will also send a request to the\n[Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_postsession).\n\nSubsequent requests using the SDK will automatically have the necessary authentication headers / session\nset." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The authentication JWT token" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth.login(\n \"customer\",\n \"emailpass\",\n {\n email: \"customer@gmail.com\",\n password: \"supersecret\"\n }\n).then((token) => {\n console.log(token)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 62, + "name": "actor", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor type. For example, " + }, + { + "kind": "code", + "text": "`user`" + }, + { + "kind": "text", + "text": " for admin user, or " + }, + { + "kind": "code", + "text": "`customer`" + }, + { + "kind": "text", + "text": " for customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 63, + "name": "method", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The authentication provider to use. For example, " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 64, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to pass in the request's body for authentication. When using the " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": " provider,\nyou pass the email and password." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/auth/payloads.ts", + "qualifiedName": "AdminSignInWithEmailPassword" + }, + "name": "AdminSignInWithEmailPassword", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 65, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 66, + "name": "location", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 66 + ] + } + ] + } + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 67, + "name": "callback", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 68, + "name": "callback", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.\nIt sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providercallback)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The authentication JWT token" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth.callback(\n \"customer\",\n \"google\",\n {\n code: \"123\",\n }\n).then((token) => {\n console.log(token)\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 69, + "name": "actor", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor type. For example, " + }, + { + "kind": "code", + "text": "`user`" + }, + { + "kind": "text", + "text": " for admin user, or " + }, + { + "kind": "code", + "text": "`customer`" + }, + { + "kind": "text", + "text": " for customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 70, + "name": "method", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The authentication provider to use. For example, " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 71, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The query parameters from the Oauth callback, which should be passed to the API route." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 72, + "name": "refresh", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 73, + "name": "refresh", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method refreshes a JWT authentication token, which is useful after validating the Oauth callback\nwith " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "callback", + "target": 67, + "tsLinkText": "" + }, + { + "kind": "text", + "text": ". It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth_postadminauthtokenrefresh)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The refreshed JWT authentication token." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth.refresh()\n.then((token) => {\n console.log(token)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 74, + "name": "logout", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 75, + "name": "logout", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes the authentication session of the currently logged-in user to log them out.\nIt sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_deletesession)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth.logout()\n.then(() => {\n // user is logged out\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 76, + "name": "resetPassword", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 77, + "name": "resetPassword", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method requests a reset password token for an admin user, customer, or custom actor type.\nIt sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerresetpassword).\n\nTo reset the password later using the token delivered to the user, use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "updateProvider", + "target": 83, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method.\n\nRelated guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth.resetPassword(\n \"customer\",\n \"emailpass\",\n {\n identifier: \"customer@gmail.com\"\n }\n)\n.then(() => {\n // user receives token\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 78, + "name": "actor", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor type. For example, " + }, + { + "kind": "code", + "text": "`user`" + }, + { + "kind": "text", + "text": " for admin user, or " + }, + { + "kind": "code", + "text": "`customer`" + }, + { + "kind": "text", + "text": " for customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 79, + "name": "provider", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The authentication provider to use. For example, " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 80, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data required to identify the user." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 81, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 82, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's identifier. For example, when using the " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": " provider,\nthis would be the user's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 82 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 83, + "name": "updateProvider", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 84, + "name": "updateProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to update user-related data authentication data.\n\nMore specifically, use this method when updating the password of an admin user, customer, or \ncustom actor type after requesting to reset their password with " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "resetPassword", + "target": 76, + "tsLinkText": "" + }, + { + "kind": "text", + "text": ".\n\nThis method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerupdate).\n\nRelated guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.auth.updateProvider(\n \"customer\",\n \"emailpass\",\n {\n email: \"customer@gmail.com\",\n password: \"supersecret\"\n }\n)\n.then(() => {\n // password updated\n})\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 85, + "name": "actor", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor type. For example, " + }, + { + "kind": "code", + "text": "`user`" + }, + { + "kind": "text", + "text": " for admin user, or " + }, + { + "kind": "code", + "text": "`customer`" + }, + { + "kind": "text", + "text": " for customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 86, + "name": "provider", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The authentication provider to use. For example, " + }, + { + "kind": "code", + "text": "`emailpass`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 87, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data necessary to update the user's authentication data. When resetting the user's password, \nsend the " + }, + { + "kind": "code", + "text": "`email`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`password`" + }, + { + "kind": "text", + "text": " properties." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 49 + ] + }, + { + "title": "Methods", + "children": [ + 55, + 60, + 67, + 72, + 74, + 76, + 83 + ] + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 48 + ] + } + ] + }, + { + "id": 91, + "name": "store", + "variant": "declaration", + "kind": 2, + "flags": {}, + "children": [ + { + "id": 92, + "name": "Store", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 97, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 98, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 99, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves the paginated list of regions in the store. It sends a request to the \n[List Regions API route](https://docs.medusajs.com/v2/api/store#regions_getregions).\n\nRelated guide: [How to list regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/list)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of regions:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.region.list()\n.then(({ regions, count, limit, offset }) => {\n console.log(regions)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.region.list({\n limit: 10,\n offset: 10\n})\n.then(({ regions, count, limit, offset }) => {\n console.log(regions)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each region:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.region.list({\n fields: \"id,*countries\"\n})\n.then(({ regions, count, limit, offset }) => {\n console.log(regions)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 100, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 101, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of regions." + } + ] + } + ] + }, + "parameters": [ + { + "id": 102, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/store/queries.ts", + "qualifiedName": "StoreRegionFilters" + }, + "name": "StoreRegionFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 103, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/store/responses.ts", + "qualifiedName": "StoreRegionListResponse" + }, + "name": "StoreRegionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 104, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/v2/api/store#regions_getregionsid)\nAPI route.\n\nRelated guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/store-retrieve-region)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a region by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.region.retrieve(\"reg_123\")\n.then(({ region }) => {\n console.log(region)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.region.retrieve(\n \"reg_123\",\n {\n fields: \"id,*countries\"\n }\n)\n.then(({ region }) => {\n console.log(region)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 105, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 106, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The region." + } + ] + } + ] + }, + "parameters": [ + { + "id": 107, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 108, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the region." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 109, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/region/store/responses.ts", + "qualifiedName": "StoreRegionResponse" + }, + "name": "StoreRegionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 99, + 104 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 110, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 111, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 112, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of product collections. It sends a request to the\n[List Collections](https://docs.medusajs.com/v2/api/store#collections_getcollections) API route.\n\nRelated guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of collections:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.collection.list()\n.then(({ collections, count, limit, offset }) => {\n console.log(collections)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.collection.list({\n limit: 10,\n offset: 10\n})\n.then(({ collections, count, limit, offset }) => {\n console.log(collections)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each collection:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.collection.list({\n fields: \"id,handle\"\n})\n.then(({ collections, count, limit, offset }) => {\n console.log(collections)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 113, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 114, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of collections." + } + ] + } + ] + }, + "parameters": [ + { + "id": 115, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/store/queries.ts", + "qualifiedName": "StoreCollectionFilters" + }, + "name": "StoreCollectionFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 116, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/store/responses.ts", + "qualifiedName": "StoreCollectionListResponse" + }, + "name": "StoreCollectionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 117, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/v2/api/store#collections_getcollectionsid)\nAPI route.\n\nRelated guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a collection by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.collection.retrieve(\"pcol_123\")\n.then(({ collection }) => {\n console.log(collection)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.collection.retrieve(\"pcol_123\", {\n fields: \"id,handle\"\n})\n.then(({ collection }) => {\n console.log(collection)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 118, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 119, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The collection." + } + ] + } + ] + }, + "parameters": [ + { + "id": 120, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the collection to retrieve." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 121, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the collection." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 122, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/collection/store/responses.ts", + "qualifiedName": "StoreCollectionResponse" + }, + "name": "StoreCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 112, + 117 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 123, + "name": "category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 124, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 125, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of product categories. It sends a request to the \n[List Categories](https://docs.medusajs.com/v2/api/store#product-categories_getproductcategories) API route.\n\nRelated guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of categoreis:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.category.list()\n.then(({ product_categories, count, offset, limit }) => {\n console.log(product_categories)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.category.list({\n limit: 10,\n offset: 10\n})\n.then(({ product_categories, count, offset, limit }) => {\n console.log(product_categories)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each category:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.category.list({\n fields: \"id,*parent_category\"\n})\n.then(({ product_categories, count, offset, limit }) => {\n console.log(product_categories)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 126, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 127, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of categoreis." + } + ] + } + ] + }, + "parameters": [ + { + "id": 128, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/store/queries.ts", + "qualifiedName": "StoreProductCategoryListParams" + }, + "name": "StoreProductCategoryListParams", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 129, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/store/responses.ts", + "qualifiedName": "StoreProductCategoryListResponse" + }, + "name": "StoreProductCategoryListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 130, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a category by its ID. It sends a request to the \n[Retrieve Product Category](https://docs.medusajs.com/v2/api/store#product-categories_getproductcategoriesid).\n\nRelated guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a category by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.category.retrieve(\"pcat_123\")\n.then(({ product_category }) => {\n console.log(product_category)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.category.retrieve(\"pcat_123\", {\n fields: \"id,*parent_category\"\n})\n.then(({ product_category }) => {\n console.log(product_category)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 131, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 132, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The category." + } + ] + } + ] + }, + "parameters": [ + { + "id": 133, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the category to retrieve." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 134, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the category." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/store/queries.ts", + "qualifiedName": "StoreProductCategoryParams" + }, + "name": "StoreProductCategoryParams", + "package": "@medusajs/types" + } + }, + { + "id": 135, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product-category/store/responses.ts", + "qualifiedName": "StoreProductCategoryResponse" + }, + "name": "StoreProductCategoryResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 125, + 130 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 136, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 137, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 138, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a list of products. It sends a request to the\n[List Products API route](https://docs.medusajs.com/v2/api/store#products_getproducts).\n\nRelated guides:\n\n- [How to list products in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/list).\n- [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of products:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.product.list()\n.then(({ products, count, offset, limit }) => {\n console.log(products)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.product.list({\n limit: 10,\n offset: 10\n})\n.then(({ products, count, offset, limit }) => {\n console.log(products)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each product:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.product.list({\n fields: \"id,*collection\"\n})\n.then(({ products, count, offset, limit }) => {\n console.log(products)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 139, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 140, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of products." + } + ] + } + ] + }, + "parameters": [ + { + "id": 141, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/store/queries.ts", + "qualifiedName": "StoreProductParams" + }, + "name": "StoreProductParams", + "package": "@medusajs/types" + } + }, + { + "id": 142, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/store/responses.ts", + "qualifiedName": "StoreProductListResponse" + }, + "name": "StoreProductListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 143, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a product by its ID. It sends a request to the \n[Get Product](https://docs.medusajs.com/v2/api/store#products_getproductsid) API route.\n\nRelated guides:\n\n- [How to retrieve a product in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/retrieve).\n- [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a product by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.product.retrieve(\"prod_123\")\n.then(({ product }) => {\n console.log(product)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.product.retrieve(\"prod_123\", {\n fields: \"id,*collection\"\n})\n.then(({ product }) => {\n console.log(product)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 144, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 145, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The product." + } + ] + } + ] + }, + "parameters": [ + { + "id": 146, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 147, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the product." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 148, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request" + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/product/store/responses.ts", + "qualifiedName": "StoreProductResponse" + }, + "name": "StoreProductResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 138, + 143 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 149, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart)." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 150, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 151, + "name": "create", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/v2/api/store#carts_postcarts)\nAPI route.\n\nRelated guide: [How to create a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/create)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.create({\n region_id: \"reg_123\"\n})\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 152, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 153, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The created cart." + } + ] + } + ] + }, + "parameters": [ + { + "id": 154, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the cart to create." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/payloads.ts", + "qualifiedName": "StoreCreateCart" + }, + "name": "StoreCreateCart", + "package": "@medusajs/types" + } + }, + { + "id": 155, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 156, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCartResponse" + }, + "name": "StoreCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 157, + "name": "update", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a cart. It sends a request to the\n[Update Cart](https://docs.medusajs.com/v2/api/store#carts_postcartsid) API route.\n\nRelated guide: [How to update a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/update)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.update(\"cart_123\", {\n region_id: \"reg_123\"\n})\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 158, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 159, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The updated cart." + } + ] + } + ] + }, + "parameters": [ + { + "id": 160, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 161, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/payloads.ts", + "qualifiedName": "StoreUpdateCart" + }, + "name": "StoreUpdateCart", + "package": "@medusajs/types" + } + }, + { + "id": 162, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 163, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCartResponse" + }, + "name": "StoreCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 164, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a cart by its ID. It sends a request to the \n[Get Cart](https://docs.medusajs.com/v2/api/store#carts_getcartsid) API route.\n\nRelated guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/retrieve)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve a cart by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.cart.retrieve(\"cart_123\")\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.cart.retrieve(\"cart_123\", {\n fields: \"id,*items\"\n})\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 165, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 166, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The cart's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 167, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 168, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 169, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCartResponse" + }, + "name": "StoreCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 170, + "name": "createLineItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This methods adds a product variant to the cart as a line item. It sends a request to the\n[Add Line Item](https://docs.medusajs.com/v2/api/store#carts_postcartsidlineitems) API route.\n\nRelated guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.createLineItem(\"cart_123\", {\n variant_id: \"variant_123\",\n quantity: 1\n})\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 171, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 172, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The cart's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 173, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 174, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the item to add." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/payloads.ts", + "qualifiedName": "StoreAddCartLineItem" + }, + "name": "StoreAddCartLineItem", + "package": "@medusajs/types" + } + }, + { + "id": 175, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 176, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCartResponse" + }, + "name": "StoreCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 177, + "name": "updateLineItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates a line item in a cart. It sends a request to the \n[Update Line Item](https://docs.medusajs.com/v2/api/store#carts_postcartsidlineitemsline_id) API route.\n\nRelated guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.updateLineItem(\n \"cart_123\", \n \"li_123\",\n {\n quantity: 1\n }\n)\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 178, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 179, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The cart's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 180, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 181, + "name": "lineItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 182, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/payloads.ts", + "qualifiedName": "StoreUpdateCartLineItem" + }, + "name": "StoreUpdateCartLineItem", + "package": "@medusajs/types" + } + }, + { + "id": 183, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 184, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCartResponse" + }, + "name": "StoreCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 185, + "name": "deleteLineItem", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes a line item from a cart. It sends a request to the\n[Remove Line Item](https://docs.medusajs.com/v2/api/store#carts_deletecartsidlineitemsline_id) API route.\n\nRelated guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.deleteLineItem(\n \"cart_123\",\n \"li_123\"\n)\n.then(({ deleted, parent: cart }) => {\n console.log(deleted, cart)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 186, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 187, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The deletion's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 188, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 189, + "name": "lineItemId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 190, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreLineItemDeleteResponse" + }, + "name": "StoreLineItemDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 191, + "name": "addShippingMethod", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method adds a shipping method to a cart. It sends a request to \nthe [Add Shipping Method](https://docs.medusajs.com/v2/api/store#carts_postcartsidshippingmethods) API routes.\n\nRelated guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.addShippingMethod(\"cart_123\", {\n option_id: \"so_123\",\n data: {\n // custom data for fulfillment provider.\n }\n})\n.then(({ cart }) => {\n console.log(cart)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 192, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 193, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The cart's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 194, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 195, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/payloads.ts", + "qualifiedName": "StoreAddCartShippingMethods" + }, + "name": "StoreAddCartShippingMethods", + "package": "@medusajs/types" + } + }, + { + "id": 196, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the cart." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 197, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCartResponse" + }, + "name": "StoreCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 198, + "name": "complete", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method completes a cart and places the order. It's the last step of the checkout flow.\nThe method sends a request to the [Complete Cart](https://docs.medusajs.com/v2/api/store#carts_postcartsidcomplete)\nAPI route.\n\nRelated guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.cart.complete(\"cart_123\")\n.then((data) => {\n if(data.type === \"cart\") {\n // an error occurred\n console.log(data.error, data.cart)\n } else {\n // order placed successfully\n console.log(data.order)\n }\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 199, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 200, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The order's details, if it was placed successfully. Otherwise, the cart is returned with an error." + } + ] + } + ] + }, + "parameters": [ + { + "id": 201, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 202, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the created order." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 203, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/responses.ts", + "qualifiedName": "StoreCompleteCartResponse" + }, + "name": "StoreCompleteCartResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 151, + 157, + 164, + 170, + 177, + 185, + 191, + 198 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 204, + "name": "fulfillment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 205, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 206, + "name": "listCartOptions", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves the list of shipping options for a cart. It sends a request to\nthe [List Shipping Options](https://docs.medusajs.com/v2/api/store#shipping-options_getshippingoptions)\nAPI route.\n\nRelated guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.fulfillment.listCartOptions({\n cart_id: \"cart_123\"\n})\n.then(({ shipping_options }) => {\n console.log(shipping_options)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 208, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The shipping options that can be used for the cart." + } + ] + } + ] + }, + "parameters": [ + { + "id": 209, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's details along with configurations of the fields to retrieve in the options." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/store/queries.ts", + "qualifiedName": "StoreGetShippingOptionList" + }, + "name": "StoreGetShippingOptionList", + "package": "@medusajs/types" + } + }, + { + "id": 210, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/shipping-option/store/responses.ts", + "qualifiedName": "StoreShippingOptionListResponse" + }, + "name": "StoreShippingOptionListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 206 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 211, + "name": "payment", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 212, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 213, + "name": "listPaymentProviders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves the payment providers available in a region, which is useful during checkout.\nIt sends a request to the [List Payment Providers](https://docs.medusajs.com/v2/api/store#payment-providers_getpaymentproviders)\nAPI route.\n\nRelated guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of payment providers for a region:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.payment.listPaymentProviders({\n region_id: \"reg_123\"\n})\n.then(({ payment_providers, count, offset, limit }) => {\n console.log(payment_providers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.payment.listPaymentProviders({\n region_id: \"reg_123\",\n limit: 10,\n offset: 10\n})\n.then(({ payment_providers, count, offset, limit }) => {\n console.log(payment_providers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each provider:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.payment.listPaymentProviders({\n region_id: \"reg_123\",\n limit: 10,\n offset: 10,\n fields: \"id\"\n})\n.then(({ payment_providers, count, offset, limit }) => {\n console.log(payment_providers)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 214, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 215, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of payment providers." + } + ] + } + ] + }, + "parameters": [ + { + "id": 216, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filters to apply on the retrieved providers, along with configurations of the \nfields to retrieve in the options." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/store/queries.ts", + "qualifiedName": "StorePaymentProviderFilters" + }, + "name": "StorePaymentProviderFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 217, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/store/responses.ts", + "qualifiedName": "StorePaymentProviderListResponse" + }, + "name": "StorePaymentProviderListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 218, + "name": "initiatePaymentSession", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates a payment session of a cart's payment collection, selecting a payment provider.\nIt sends a request to the [Initialize Payment Session](https://docs.medusajs.com/v2/api/store#payment-collections_postpaymentcollectionsidpaymentsessions)\nAPI route.\n\nIf the cart doesn't have a payment collection, a payment collection is created for the cart by\nsending a request to the [Create Payment Collection](https://docs.medusajs.com/v2/api/store#payment-collections_postpaymentcollections)\nAPI route.\n\nRelated guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.payment.initiatePaymentSession(\n cart, // assuming you already have the cart object.\n {\n provider_id: \"pp_stripe_stripe\",\n data: {\n // any data relevant for the provider.\n }\n }\n)\n.then(({ payment_collection }) => {\n console.log(payment_collection)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 219, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 220, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The payment collection's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 221, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/cart/store/entities.ts", + "qualifiedName": "StoreCart" + }, + "name": "StoreCart", + "package": "@medusajs/types" + } + }, + { + "id": 222, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment session's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/store/payloads.ts", + "qualifiedName": "StoreInitializePaymentSession" + }, + "name": "StoreInitializePaymentSession", + "package": "@medusajs/types" + } + }, + { + "id": 223, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the payment collection." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 224, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/payment/store/responses.ts", + "qualifiedName": "StorePaymentCollectionResponse" + }, + "name": "StorePaymentCollectionResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 213, + 218 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 225, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 226, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 227, + "name": "list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves a paginated list of orders matching the specified filters. It\nsends a request to the [List Orders](https://docs.medusajs.com/v2/api/store#orders_getorders)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of orders:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.order.list()\n.then(({ orders, count, offset, limit }) => {\n console.log(orders)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.order.list({\n limit: 10,\n offset: 10\n})\n.then(({ orders, count, offset, limit }) => {\n console.log(orders)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each order:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.order.list({\n fields: \"id,*items\"\n})\n.then(({ orders, count, offset, limit }) => {\n console.log(orders)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 228, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 229, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of orders." + } + ] + } + ] + }, + "parameters": [ + { + "id": 230, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the orders." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/store/queries.ts", + "qualifiedName": "StoreOrderFilters" + }, + "name": "StoreOrderFilters", + "package": "@medusajs/types" + } + }, + { + "id": 231, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/store/responses.ts", + "qualifiedName": "StoreOrderListResponse" + }, + "name": "StoreOrderListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 232, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves an order by its ID. It sends a request to the \n[Get Order](https://docs.medusajs.com/v2/api/store#orders_getordersid) API route." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve an order by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.order.retrieve(\"order_123\")\n.then(({ order }) => {\n console.log(order)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.order.retrieve(\"order_123\", {\n fields: \"id,*items\"\n})\n.then(({ order }) => {\n console.log(order)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 233, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 234, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The order's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 235, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 236, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the order." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 237, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 238, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 239, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/order/store/entities.ts", + "qualifiedName": "StoreOrder" + }, + "name": "StoreOrder", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 239 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 227, + 232 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 240, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 241, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 242, + "name": "create", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/v2/api/store#customers_postcustomers)\nAPI route.\n\nYou must use the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.register" + }, + { + "kind": "text", + "text": " method first to retrieve a registration token. Then, pass that\nregistration token in the " + }, + { + "kind": "code", + "text": "`headers`" + }, + { + "kind": "text", + "text": " parameter of this method as an authorization bearer header. \n\nRelated guide: [How to register customer in storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/register)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nconst token = await sdk.auth.register(\"customer\", \"emailpass\", {\n \"email\": \"customer@gmail.com\",\n \"password\": \"supersecret\"\n})\n\nsdk.store.customer.create(\n {\n \"email\": \"customer@gmail.com\"\n },\n {},\n {\n authorization: `Bearer ${token}`\n }\n)\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 243, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 244, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 245, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/payloads.ts", + "qualifiedName": "StoreCreateCustomer" + }, + "name": "StoreCreateCustomer", + "package": "@medusajs/types" + } + }, + { + "id": 246, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 247, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request. This is where you include the authorization JWT registration token." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerResponse" + }, + "name": "StoreCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 248, + "name": "update", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates the logged-in customer's details. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the\n[Update Customer](https://docs.medusajs.com/v2/api/store#customers_postcustomersme) API route.\n\nRelated guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/profile)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.customer.update({\n first_name: \"John\"\n})\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 249, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 250, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 251, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's details to update." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/payloads.ts", + "qualifiedName": "StoreUpdateCustomer" + }, + "name": "StoreUpdateCustomer", + "package": "@medusajs/types" + } + }, + { + "id": 252, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 253, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerResponse" + }, + "name": "StoreCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 254, + "name": "retrieve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves the logged-in customer's details. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/v2/api/store#customers_getcustomersme)\nAPI route." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.customer.retrieve()\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 257, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 258, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerResponse" + }, + "name": "StoreCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 259, + "name": "createAddress", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method creates an address for the logged-in customer. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the [Create Address](https://docs.medusajs.com/v2/api/store#customers_postcustomersmeaddresses)\nAPI route.\n\nRelated guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.customer.createAddress({\n country_code: \"us\"\n})\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 260, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 261, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 262, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The address's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/payloads.ts", + "qualifiedName": "StoreCreateCustomerAddress" + }, + "name": "StoreCreateCustomerAddress", + "package": "@medusajs/types" + } + }, + { + "id": 263, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 264, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerResponse" + }, + "name": "StoreCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 265, + "name": "updateAddress", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method updates the address of the logged-in customer. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the [Update Address](https://docs.medusajs.com/v2/api/store#customers_postcustomersmeaddressesaddress_id)\nAPI route.\n\nRelated guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.customer.updateAddress(\n \"caddr_123\",\n {\n country_code: \"us\"\n }\n)\n.then(({ customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 266, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 267, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The customer's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 268, + "name": "addressId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the address to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 269, + "name": "body", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the address." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/payloads.ts", + "qualifiedName": "StoreUpdateCustomerAddress" + }, + "name": "StoreUpdateCustomerAddress", + "package": "@medusajs/types" + } + }, + { + "id": 270, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 271, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerResponse" + }, + "name": "StoreCustomerResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 272, + "name": "listAddress", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves the logged-in customer's address. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the [List Customer's Address](https://docs.medusajs.com/v2/api/store#customers_getcustomersmeaddresses)\nAPI route.\n\nRelated guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve the list of addresses:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.customer.listAddress()\n.then(({ addresses, count, offset, limit }) => {\n console.log(addresses)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo configure the pagination, pass the " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " query parameters.\n\nFor example, to retrieve only 10 items and skip 10 items:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.customer.listAddress({\n limit: 10,\n offset: 10\n})\n.then(({ addresses, count, offset, limit }) => {\n console.log(addresses)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nUsing the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " query parameter, you can specify the fields and relations to retrieve\nin each address:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.customer.listAddress({\n fields: \"id,country_code\"\n})\n.then(({ addresses, count, offset, limit }) => {\n console.log(addresses)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 273, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 274, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The paginated list of addresses." + } + ] + } + ] + }, + "parameters": [ + { + "id": 275, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the addresses." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "FindParams" + }, + "name": "FindParams", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/queries.ts", + "qualifiedName": "StoreCustomerAddressFilters" + }, + "name": "StoreCustomerAddressFilters", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 276, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerAddressListResponse" + }, + "name": "StoreCustomerAddressListResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 277, + "name": "retrieveAddress", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves an address of the logged-in customer. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the [Get Address](https://docs.medusajs.com/v2/api/store#customers_getcustomersmeaddressesaddress_id)\nAPI route.\n\nRelated guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "To retrieve an address by its ID:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.customer.retrieveAddress(\n \"caddr_123\"\n)\n.then(({ address }) => {\n console.log(address)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nTo specify the fields and relations to retrieve:\n\n" + }, + { + "kind": "code", + "text": "```ts\nsdk.store.customer.retrieveAddress(\n \"caddr_123\",\n {\n fields: \"id,country_code\"\n }\n)\n.then(({ address }) => {\n console.log(address)\n})\n```" + }, + { + "kind": "text", + "text": "\n\nLearn more about the " + }, + { + "kind": "code", + "text": "`fields`" + }, + { + "kind": "text", + "text": " property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations)." + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 278, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 279, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The address's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 280, + "name": "addressId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The address's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 281, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure the fields to retrieve in the address." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/common/request.ts", + "qualifiedName": "SelectParams" + }, + "name": "SelectParams", + "package": "@medusajs/types" + } + }, + { + "id": 282, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerAddressResponse" + }, + "name": "StoreCustomerAddressResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 283, + "name": "deleteAddress", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method deletes an address of the logged-in customer. The customer must be logged in\nfirst with the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "Auth.login" + }, + { + "kind": "text", + "text": " method.\n\nIt sends a request to the [Remove Address](https://docs.medusajs.com/v2/api/store#customers_deletecustomersmeaddressesaddress_id)\nAPI route.\n\nRelated guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nsdk.store.customer.deleteAddress(\"caddr_123\")\n.then(({ deleted, parent: customer }) => {\n console.log(customer)\n})\n```" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 284, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 285, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The deletion's details." + } + ] + } + ] + }, + "parameters": [ + { + "id": 286, + "name": "addressId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The address's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 287, + "name": "headers", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers to pass in the request." + } + ] + }, + "type": { + "type": "reference", + "target": 1999, + "name": "ClientHeaders", + "package": "@medusajs/js-sdk" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../../packages/core/types/src/http/customer/store/responses.ts", + "qualifiedName": "StoreCustomerAddressDeleteResponse" + }, + "name": "StoreCustomerAddressDeleteResponse", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 242, + 248, + 254, + 259, + 265, + 272, + 277, + 283 + ] + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 97, + 110, + 123, + 136, + 149, + 204, + 211, + 225, + 240 + ] + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 92 + ] + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "children": [ + 1, + 47, + 91 + ] + } + ], + "packageName": "@medusajs/js-sdk", + "symbolIdMap": { + "1": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "" + }, + "2": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin" + }, + "3": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.__constructor" + }, + "4": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin" + }, + "5": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "client" + }, + "6": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.invite" + }, + "7": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.customer" + }, + "8": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.productCollection" + }, + "9": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.productCategory" + }, + "10": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.priceList" + }, + "11": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.pricePreference" + }, + "12": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.product" + }, + "13": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.productType" + }, + "14": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.upload" + }, + "15": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.region" + }, + "16": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.returnReason" + }, + "17": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.stockLocation" + }, + "18": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.salesChannel" + }, + "19": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.fulfillmentSet" + }, + "20": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.fulfillment" + }, + "21": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.fulfillmentProvider" + }, + "22": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.shippingOption" + }, + "23": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.shippingProfile" + }, + "24": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.inventoryItem" + }, + "25": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.notification" + }, + "26": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.order" + }, + "27": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.orderEdit" + }, + "28": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.return" + }, + "29": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.claim" + }, + "30": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.exchange" + }, + "31": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.taxRate" + }, + "32": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.taxRegion" + }, + "33": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.store" + }, + "34": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.productTag" + }, + "35": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.user" + }, + "36": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.currency" + }, + "37": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.payment" + }, + "38": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.productVariant" + }, + "39": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.refundReason" + }, + "40": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.paymentCollection" + }, + "41": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.apiKey" + }, + "42": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.workflowExecution" + }, + "43": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.reservation" + }, + "44": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.customerGroup" + }, + "45": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.promotion" + }, + "46": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", + "qualifiedName": "Admin.campaign" + }, + "47": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "" + }, + "48": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth" + }, + "49": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.__constructor" + }, + "50": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth" + }, + "51": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "client" + }, + "52": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "config" + }, + "55": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.register" + }, + "56": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.register" + }, + "57": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "actor" + }, + "58": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "method" + }, + "59": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "payload" + }, + "60": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.login" + }, + "61": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.login" + }, + "62": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "actor" + }, + "63": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "method" + }, + "64": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "payload" + }, + "65": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "__object" + }, + "66": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "__object.location" + }, + "67": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.callback" + }, + "68": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.callback" + }, + "69": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "actor" + }, + "70": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "method" + }, + "71": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "query" + }, + "72": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.refresh" + }, + "73": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.refresh" + }, + "74": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.logout" + }, + "75": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.logout" + }, + "76": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.resetPassword" + }, + "77": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.resetPassword" + }, + "78": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "actor" + }, + "79": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "provider" + }, + "80": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "body" + }, + "81": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "__type" + }, + "82": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "__type.identifier" + }, + "83": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.updateProvider" + }, + "84": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "Auth.updateProvider" + }, + "85": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "actor" + }, + "86": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "provider" + }, + "87": { + "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", + "qualifiedName": "body" + }, + "91": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "" + }, + "92": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store" + }, + "97": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.region" + }, + "98": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "99": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.list" + }, + "100": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "101": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "102": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "103": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "104": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "105": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "106": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "107": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "108": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "109": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "110": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.collection" + }, + "111": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "112": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.list" + }, + "113": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "114": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "115": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "116": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "117": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "118": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "119": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "120": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "121": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "122": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "123": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.category" + }, + "124": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "125": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.list" + }, + "126": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "127": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "128": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "129": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "130": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "131": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "132": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "133": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "134": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "135": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "136": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.product" + }, + "137": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "138": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.list" + }, + "139": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "140": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "141": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "142": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "143": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "144": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "145": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "146": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "147": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "148": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "149": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.cart" + }, + "150": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "151": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.create" + }, + "152": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "153": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "154": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "155": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "156": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "157": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.update" + }, + "158": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "159": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "160": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "161": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "162": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "163": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "164": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "165": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "166": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "167": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "168": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "169": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "170": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.createLineItem" + }, + "171": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "172": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "173": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "cartId" + }, + "174": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "175": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "176": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "177": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.updateLineItem" + }, + "178": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "179": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "180": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "cartId" + }, + "181": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "lineItemId" + }, + "182": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "183": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "184": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "185": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.deleteLineItem" + }, + "186": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "187": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "188": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "cartId" + }, + "189": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "lineItemId" + }, + "190": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "191": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.addShippingMethod" + }, + "192": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "193": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "194": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "cartId" + }, + "195": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "196": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "197": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "198": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.complete" + }, + "199": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "200": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "201": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "cartId" + }, + "202": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "203": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "204": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.fulfillment" + }, + "205": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "206": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.listCartOptions" + }, + "207": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "208": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "209": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "210": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "211": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.payment" + }, + "212": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "213": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.listPaymentProviders" + }, + "214": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "215": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "216": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "217": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "218": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.initiatePaymentSession" + }, + "219": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "220": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "221": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "cart" + }, + "222": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "223": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "224": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "225": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.order" + }, + "226": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "227": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.list" + }, + "228": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "229": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "230": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "231": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "232": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "233": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "234": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "235": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "id" + }, + "236": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "237": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "238": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__type" + }, + "239": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__type.order" + }, + "240": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "Store.customer" + }, + "241": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object" + }, + "242": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.create" + }, + "243": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "244": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "245": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "246": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "247": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "248": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.update" + }, + "249": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "250": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "251": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "252": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "253": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "254": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieve" + }, + "255": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "256": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "257": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "258": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "259": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.createAddress" + }, + "260": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "261": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "262": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "263": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "264": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "265": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.updateAddress" + }, + "266": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "267": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "268": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "addressId" + }, + "269": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "body" + }, + "270": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "271": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "272": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.listAddress" + }, + "273": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "274": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "275": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "276": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "277": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.retrieveAddress" + }, + "278": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "279": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "280": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "addressId" + }, + "281": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "query" + }, + "282": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "283": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__object.deleteAddress" + }, + "284": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "285": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "__function" + }, + "286": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "addressId" + }, + "287": { + "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", + "qualifiedName": "headers" + }, + "288": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite" + }, + "289": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.__constructor" + }, + "290": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite" + }, + "291": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "client" + }, + "292": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.client" + }, + "293": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.accept" + }, + "294": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.accept" + }, + "295": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "input" + }, + "296": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type" + }, + "297": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type.invite_token" + }, + "298": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "query" + }, + "299": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "headers" + }, + "300": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type" + }, + "301": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type.user" + }, + "302": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.create" + }, + "303": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.create" + }, + "304": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "body" + }, + "305": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "query" + }, + "306": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "headers" + }, + "307": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type" + }, + "308": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type.invite" + }, + "309": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.retrieve" + }, + "310": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.retrieve" + }, + "311": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "id" + }, + "312": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "query" + }, + "313": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "headers" + }, + "314": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type" + }, + "315": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type.invite" + }, + "316": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.list" + }, + "317": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.list" + }, + "318": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "queryParams" + }, + "319": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "headers" + }, + "320": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type" + }, + "321": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type.invites" + }, + "322": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.resend" + }, + "323": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.resend" + }, + "324": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "id" + }, + "325": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "headers" + }, + "326": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type" + }, + "327": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "__type.invite" + }, + "328": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.delete" + }, + "329": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "Invite.delete" + }, + "330": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "id" + }, + "331": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", + "qualifiedName": "headers" + }, + "332": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer" + }, + "333": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.__constructor" + }, + "334": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer" + }, + "335": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "client" + }, + "336": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.client" + }, + "337": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.create" + }, + "338": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.create" + }, + "339": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "body" + }, + "340": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "query" + }, + "341": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "headers" + }, + "342": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.update" + }, + "343": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.update" + }, + "344": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "id" + }, + "345": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "body" + }, + "346": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "query" + }, + "347": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "headers" + }, + "348": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.list" + }, + "349": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.list" + }, + "350": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "queryParams" + }, + "351": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "headers" + }, + "352": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.retrieve" + }, + "353": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.retrieve" + }, + "354": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "id" + }, + "355": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "query" + }, + "356": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "headers" + }, + "357": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.delete" + }, + "358": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "Customer.delete" + }, + "359": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "id" + }, + "360": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", + "qualifiedName": "headers" + }, + "361": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection" + }, + "362": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.__constructor" + }, + "363": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection" + }, + "364": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "client" + }, + "365": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.client" + }, + "366": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.create" + }, + "367": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.create" + }, + "368": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "body" + }, + "369": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "query" + }, + "370": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "headers" + }, + "371": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.update" + }, + "372": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.update" + }, + "373": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "id" + }, + "374": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "body" + }, + "375": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "query" + }, + "376": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "headers" + }, + "377": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.list" + }, + "378": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.list" + }, + "379": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "queryParams" + }, + "380": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "headers" + }, + "381": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.retrieve" + }, + "382": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.retrieve" + }, + "383": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "id" + }, + "384": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "query" + }, + "385": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "headers" + }, + "386": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.delete" + }, + "387": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.delete" + }, + "388": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "id" + }, + "389": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "headers" + }, + "390": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.updateProducts" + }, + "391": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "ProductCollection.updateProducts" + }, + "392": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "id" + }, + "393": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "body" + }, + "394": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", + "qualifiedName": "headers" + }, + "395": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "396": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.__constructor" + }, + "397": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "398": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "client" + }, + "399": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.client" + }, + "400": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.create" + }, + "401": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.create" + }, + "402": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "body" + }, + "403": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "query" + }, + "404": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "headers" + }, + "405": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.update" + }, + "406": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.update" + }, + "407": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "id" + }, + "408": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "body" + }, + "409": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "query" + }, + "410": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "headers" + }, + "411": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.list" + }, + "412": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.list" + }, + "413": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "query" + }, + "414": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "headers" + }, + "415": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.retrieve" + }, + "416": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.retrieve" + }, + "417": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "id" + }, + "418": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "query" + }, + "419": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "headers" + }, + "420": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.delete" + }, + "421": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.delete" + }, + "422": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "id" + }, + "423": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "headers" + }, + "424": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.updateProducts" + }, + "425": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "ProductCategory.updateProducts" + }, + "426": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "id" + }, + "427": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "body" + }, + "428": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "query" + }, + "429": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", + "qualifiedName": "headers" + }, + "430": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList" + }, + "431": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.__constructor" + }, + "432": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList" + }, + "433": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "client" + }, + "434": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.client" + }, + "435": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.retrieve" + }, + "436": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.retrieve" + }, + "437": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "id" + }, + "438": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "query" + }, + "439": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "440": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.list" + }, + "441": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.list" + }, + "442": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "query" + }, + "443": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "444": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.create" + }, + "445": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.create" + }, + "446": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "body" + }, + "447": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "query" + }, + "448": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "449": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.update" + }, + "450": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.update" + }, + "451": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "id" + }, + "452": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "body" + }, + "453": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "query" + }, + "454": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "455": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.delete" + }, + "456": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.delete" + }, + "457": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "id" + }, + "458": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "459": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.batchPrices" + }, + "460": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.batchPrices" + }, + "461": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "id" + }, + "462": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "body" + }, + "463": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "query" + }, + "464": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "465": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.linkProducts" + }, + "466": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "PriceList.linkProducts" + }, + "467": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "id" + }, + "468": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "body" + }, + "469": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "query" + }, + "470": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", + "qualifiedName": "headers" + }, + "471": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference" + }, + "472": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.__constructor" + }, + "473": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference" + }, + "474": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "client" + }, + "475": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.client" + }, + "476": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.retrieve" + }, + "477": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.retrieve" + }, + "478": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "id" + }, + "479": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "query" + }, + "480": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "headers" + }, + "481": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.list" + }, + "482": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.list" + }, + "483": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "query" + }, + "484": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "headers" + }, + "485": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.create" + }, + "486": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.create" + }, + "487": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "body" + }, + "488": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "query" + }, + "489": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "headers" + }, + "490": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.update" + }, + "491": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.update" + }, + "492": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "id" + }, + "493": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "body" + }, + "494": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "query" + }, + "495": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "headers" + }, + "496": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.delete" + }, + "497": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "PricePreference.delete" + }, + "498": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "id" + }, + "499": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", + "qualifiedName": "headers" + }, + "500": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product" + }, + "501": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.__constructor" + }, + "502": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product" + }, + "503": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "client" + }, + "504": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.client" + }, + "505": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.import" + }, + "506": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.import" + }, + "507": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "508": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "509": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "510": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "511": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.confirmImport" + }, + "512": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.confirmImport" + }, + "513": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "transactionId" + }, + "514": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "515": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "516": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "517": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "518": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.export" + }, + "519": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.export" + }, + "520": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "521": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "522": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "523": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.batch" + }, + "524": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.batch" + }, + "525": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "526": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "527": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "528": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.create" + }, + "529": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.create" + }, + "530": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "531": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "532": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "533": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.update" + }, + "534": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.update" + }, + "535": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "536": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "537": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "538": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "539": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.list" + }, + "540": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.list" + }, + "541": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "queryParams" + }, + "542": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "543": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.retrieve" + }, + "544": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.retrieve" + }, + "545": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "546": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "547": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "548": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.delete" + }, + "549": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.delete" + }, + "550": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "551": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "552": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.batchVariants" + }, + "553": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.batchVariants" + }, + "554": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "555": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "556": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "557": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "558": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.createVariant" + }, + "559": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.createVariant" + }, + "560": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "561": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "562": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "563": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "564": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.updateVariant" + }, + "565": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.updateVariant" + }, + "566": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "567": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "568": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "569": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "570": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "571": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.listVariants" + }, + "572": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.listVariants" + }, + "573": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "574": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "queryParams" + }, + "575": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "576": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.retrieveVariant" + }, + "577": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.retrieveVariant" + }, + "578": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "579": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "580": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "581": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "582": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.deleteVariant" + }, + "583": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.deleteVariant" + }, + "584": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "585": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "586": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "587": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.batchVariantInventoryItems" + }, + "588": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.batchVariantInventoryItems" + }, + "589": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "590": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "591": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "592": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "593": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.createOption" + }, + "594": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.createOption" + }, + "595": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "596": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "597": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "598": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "599": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.updateOption" + }, + "600": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.updateOption" + }, + "601": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "602": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "603": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "body" + }, + "604": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "605": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "606": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.listOptions" + }, + "607": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.listOptions" + }, + "608": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "609": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "queryParams" + }, + "610": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "611": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.retrieveOption" + }, + "612": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.retrieveOption" + }, + "613": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "614": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "615": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "query" + }, + "616": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "617": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.deleteOption" + }, + "618": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "Product.deleteOption" + }, + "619": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "productId" + }, + "620": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "id" + }, + "621": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", + "qualifiedName": "headers" + }, + "622": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType" + }, + "623": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.__constructor" + }, + "624": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType" + }, + "625": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "client" + }, + "626": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.client" + }, + "627": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.create" + }, + "628": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.create" + }, + "629": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "body" + }, + "630": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "query" + }, + "631": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "headers" + }, + "632": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.update" + }, + "633": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.update" + }, + "634": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "id" + }, + "635": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "body" + }, + "636": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "query" + }, + "637": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "headers" + }, + "638": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.list" + }, + "639": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.list" + }, + "640": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "query" + }, + "641": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "headers" + }, + "642": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.retrieve" + }, + "643": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.retrieve" + }, + "644": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "id" + }, + "645": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "query" + }, + "646": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "headers" + }, + "647": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.delete" + }, + "648": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "ProductType.delete" + }, + "649": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "id" + }, + "650": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", + "qualifiedName": "headers" + }, + "651": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload" + }, + "652": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.__constructor" + }, + "653": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload" + }, + "654": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "client" + }, + "655": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.client" + }, + "656": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.create" + }, + "657": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.create" + }, + "658": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "body" + }, + "659": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "query" + }, + "660": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "headers" + }, + "661": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "__type" + }, + "662": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "__type.files" + }, + "663": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.retrieve" + }, + "664": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.retrieve" + }, + "665": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "id" + }, + "666": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "query" + }, + "667": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "headers" + }, + "668": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "__type" + }, + "669": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "__type.file" + }, + "670": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.delete" + }, + "671": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "Upload.delete" + }, + "672": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "id" + }, + "673": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", + "qualifiedName": "headers" + }, + "674": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region" + }, + "675": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.__constructor" + }, + "676": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region" + }, + "677": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "client" + }, + "678": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.client" + }, + "679": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.create" + }, + "680": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.create" + }, + "681": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "body" + }, + "682": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "query" + }, + "683": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "headers" + }, + "684": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type" + }, + "685": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type.region" + }, + "686": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.update" + }, + "687": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.update" + }, + "688": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "id" + }, + "689": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "body" + }, + "690": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "query" + }, + "691": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "headers" + }, + "692": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type" + }, + "693": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type.region" + }, + "694": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.list" + }, + "695": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.list" + }, + "696": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "queryParams" + }, + "697": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "headers" + }, + "698": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type" + }, + "699": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type.regions" + }, + "700": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.retrieve" + }, + "701": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.retrieve" + }, + "702": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "id" + }, + "703": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "query" + }, + "704": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "headers" + }, + "705": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type" + }, + "706": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "__type.region" + }, + "707": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.delete" + }, + "708": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "Region.delete" + }, + "709": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "id" + }, + "710": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", + "qualifiedName": "headers" + }, + "711": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason" + }, + "712": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.__constructor" + }, + "713": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason" + }, + "714": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "client" + }, + "715": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.client" + }, + "716": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.list" + }, + "717": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.list" + }, + "718": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "query" + }, + "719": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "headers" + }, + "720": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.retrieve" + }, + "721": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.retrieve" + }, + "722": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "id" + }, + "723": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "query" + }, + "724": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "headers" + }, + "725": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.create" + }, + "726": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.create" + }, + "727": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "body" + }, + "728": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "query" + }, + "729": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "headers" + }, + "730": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.update" + }, + "731": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.update" + }, + "732": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "id" + }, + "733": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "body" + }, + "734": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "query" + }, + "735": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "headers" + }, + "736": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.delete" + }, + "737": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "ReturnReason.delete" + }, + "738": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "id" + }, + "739": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "query" + }, + "740": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", + "qualifiedName": "headers" + }, + "741": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation" + }, + "742": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.__constructor" + }, + "743": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation" + }, + "744": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "client" + }, + "745": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.client" + }, + "746": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.create" + }, + "747": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.create" + }, + "748": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "body" + }, + "749": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "query" + }, + "750": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "751": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.update" + }, + "752": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.update" + }, + "753": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "id" + }, + "754": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "body" + }, + "755": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "query" + }, + "756": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "757": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.delete" + }, + "758": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.delete" + }, + "759": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "id" + }, + "760": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "761": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.retrieve" + }, + "762": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.retrieve" + }, + "763": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "id" + }, + "764": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "query" + }, + "765": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "766": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.list" + }, + "767": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.list" + }, + "768": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "query" + }, + "769": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "770": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.updateSalesChannels" + }, + "771": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.updateSalesChannels" + }, + "772": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "id" + }, + "773": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "body" + }, + "774": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "775": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.createFulfillmentSet" + }, + "776": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.createFulfillmentSet" + }, + "777": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "id" + }, + "778": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "body" + }, + "779": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "780": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.updateFulfillmentProviders" + }, + "781": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "StockLocation.updateFulfillmentProviders" + }, + "782": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "id" + }, + "783": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "body" + }, + "784": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", + "qualifiedName": "headers" + }, + "785": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "786": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.__constructor" + }, + "787": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "788": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "client" + }, + "789": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.client" + }, + "790": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.create" + }, + "791": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.create" + }, + "792": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "body" + }, + "793": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "query" + }, + "794": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "795": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.update" + }, + "796": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.update" + }, + "797": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "id" + }, + "798": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "body" + }, + "799": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "query" + }, + "800": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "801": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.delete" + }, + "802": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.delete" + }, + "803": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "id" + }, + "804": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "805": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.retrieve" + }, + "806": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.retrieve" + }, + "807": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "id" + }, + "808": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "query" + }, + "809": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "810": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.list" + }, + "811": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.list" + }, + "812": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "query" + }, + "813": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "814": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.updateProducts" + }, + "815": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.updateProducts" + }, + "816": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "id" + }, + "817": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "body" + }, + "818": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "819": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.batchProducts" + }, + "820": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "SalesChannel.batchProducts" + }, + "821": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "id" + }, + "822": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "body" + }, + "823": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", + "qualifiedName": "headers" + }, + "824": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet" + }, + "825": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.__constructor" + }, + "826": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet" + }, + "827": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "client" + }, + "828": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.client" + }, + "829": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.delete" + }, + "830": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.delete" + }, + "831": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "id" + }, + "832": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "headers" + }, + "833": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.createServiceZone" + }, + "834": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.createServiceZone" + }, + "835": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "id" + }, + "836": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "body" + }, + "837": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "query" + }, + "838": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "headers" + }, + "839": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.retrieveServiceZone" + }, + "840": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.retrieveServiceZone" + }, + "841": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "fulfillmentSetId" + }, + "842": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "serviceZoneId" + }, + "843": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "query" + }, + "844": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "headers" + }, + "845": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.updateServiceZone" + }, + "846": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.updateServiceZone" + }, + "847": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "fulfillmentSetId" + }, + "848": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "serviceZoneId" + }, + "849": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "body" + }, + "850": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "query" + }, + "851": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "headers" + }, + "852": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.deleteServiceZone" + }, + "853": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "FulfillmentSet.deleteServiceZone" + }, + "854": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "fulfillmentSetId" + }, + "855": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "serviceZoneId" + }, + "856": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", + "qualifiedName": "headers" + }, + "857": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment" + }, + "858": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.__constructor" + }, + "859": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment" + }, + "860": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "client" + }, + "861": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.client" + }, + "862": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.create" + }, + "863": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.create" + }, + "864": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "body" + }, + "865": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "query" + }, + "866": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "headers" + }, + "867": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.cancel" + }, + "868": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.cancel" + }, + "869": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "id" + }, + "870": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "query" + }, + "871": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "headers" + }, + "872": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.createShipment" + }, + "873": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "Fulfillment.createShipment" + }, + "874": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "id" + }, + "875": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "body" + }, + "876": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "query" + }, + "877": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", + "qualifiedName": "headers" + }, + "878": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider" + }, + "879": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider.__constructor" + }, + "880": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider" + }, + "881": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "client" + }, + "882": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider.client" + }, + "883": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider.list" + }, + "884": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider.list" + }, + "885": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "query" + }, + "886": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "qualifiedName": "headers" + }, + "887": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption" + }, + "888": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.__constructor" + }, + "889": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption" + }, + "890": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "client" + }, + "891": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.client" + }, + "892": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.create" + }, + "893": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.create" + }, + "894": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "body" + }, + "895": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "query" + }, + "896": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "headers" + }, + "897": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.retrieve" + }, + "898": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.retrieve" + }, + "899": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "id" + }, + "900": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "query" + }, + "901": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "headers" + }, + "902": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.update" + }, + "903": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.update" + }, + "904": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "id" + }, + "905": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "body" + }, + "906": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "query" + }, + "907": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "headers" + }, + "908": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.delete" + }, + "909": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.delete" + }, + "910": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "id" + }, + "911": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "headers" + }, + "912": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.list" + }, + "913": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.list" + }, + "914": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "query" + }, + "915": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "headers" + }, + "916": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.updateRules" + }, + "917": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "ShippingOption.updateRules" + }, + "918": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "id" + }, + "919": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "body" + }, + "920": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", + "qualifiedName": "headers" + }, + "921": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile" + }, + "922": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.__constructor" + }, + "923": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile" + }, + "924": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "client" + }, + "925": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.client" + }, + "926": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.create" + }, + "927": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.create" + }, + "928": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "body" + }, + "929": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "query" + }, + "930": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "headers" + }, + "931": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.update" + }, + "932": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.update" + }, + "933": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "id" + }, + "934": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "body" + }, + "935": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "query" + }, + "936": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "headers" + }, + "937": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.delete" + }, + "938": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.delete" + }, + "939": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "id" + }, + "940": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "headers" + }, + "941": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.list" + }, + "942": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.list" + }, + "943": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "query" + }, + "944": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "headers" + }, + "945": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.retrieve" + }, + "946": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "ShippingProfile.retrieve" + }, + "947": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "id" + }, + "948": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "query" + }, + "949": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", + "qualifiedName": "headers" + }, + "950": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem" + }, + "951": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.__constructor" + }, + "952": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem" + }, + "953": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "client" + }, + "954": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.client" + }, + "955": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.create" + }, + "956": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.create" + }, + "957": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "body" + }, + "958": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "959": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "960": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.update" + }, + "961": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.update" + }, + "962": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "963": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "body" + }, + "964": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "965": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "966": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.list" + }, + "967": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.list" + }, + "968": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "969": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "970": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.retrieve" + }, + "971": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.retrieve" + }, + "972": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "973": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "974": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "975": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.delete" + }, + "976": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.delete" + }, + "977": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "978": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "979": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.listLevels" + }, + "980": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.listLevels" + }, + "981": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "982": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "983": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "984": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.updateLevel" + }, + "985": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.updateLevel" + }, + "986": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "987": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "locationId" + }, + "988": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "body" + }, + "989": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "990": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "991": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.deleteLevel" + }, + "992": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.deleteLevel" + }, + "993": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "994": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "locationId" + }, + "995": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "996": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.batchUpdateLevels" + }, + "997": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "InventoryItem.batchUpdateLevels" + }, + "998": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "id" + }, + "999": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "body" + }, + "1000": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "query" + }, + "1001": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", + "qualifiedName": "headers" + }, + "1002": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification" + }, + "1003": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification.__constructor" + }, + "1004": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification" + }, + "1005": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "client" + }, + "1006": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification.client" + }, + "1007": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification.retrieve" + }, + "1008": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification.retrieve" + }, + "1009": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "id" + }, + "1010": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "query" + }, + "1011": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "headers" + }, + "1012": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification.list" + }, + "1013": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "Notification.list" + }, + "1014": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "query" + }, + "1015": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", + "qualifiedName": "headers" + }, + "1016": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order" + }, + "1017": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.__constructor" + }, + "1018": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order" + }, + "1019": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "client" + }, + "1020": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.client" + }, + "1021": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.retrieve" + }, + "1022": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.retrieve" + }, + "1023": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1024": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "query" + }, + "1025": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1026": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1027": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.order" + }, + "1028": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.retrievePreview" + }, + "1029": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.retrievePreview" + }, + "1030": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1031": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "query" + }, + "1032": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1033": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.list" + }, + "1034": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.list" + }, + "1035": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "queryParams" + }, + "1036": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1037": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1038": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.orders" + }, + "1039": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.cancel" + }, + "1040": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.cancel" + }, + "1041": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1042": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1043": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1044": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.order" + }, + "1045": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.createFulfillment" + }, + "1046": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.createFulfillment" + }, + "1047": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1048": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "body" + }, + "1049": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "query" + }, + "1050": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1051": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1052": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.order" + }, + "1053": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.cancelFulfillment" + }, + "1054": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.cancelFulfillment" + }, + "1055": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1056": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "fulfillmentId" + }, + "1057": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "body" + }, + "1058": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1059": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1060": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.order" + }, + "1061": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.createShipment" + }, + "1062": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.createShipment" + }, + "1063": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1064": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "fulfillmentId" + }, + "1065": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "body" + }, + "1066": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "query" + }, + "1067": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1068": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1069": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.order" + }, + "1070": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.markAsDelivered" + }, + "1071": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.markAsDelivered" + }, + "1072": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1073": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "fulfillmentId" + }, + "1074": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "body" + }, + "1075": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "query" + }, + "1076": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1077": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type" + }, + "1078": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "__type.order" + }, + "1079": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.listChanges" + }, + "1080": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.listChanges" + }, + "1081": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1082": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "queryParams" + }, + "1083": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1084": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.listLineItems" + }, + "1085": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "Order.listLineItems" + }, + "1086": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "id" + }, + "1087": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "queryParams" + }, + "1088": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", + "qualifiedName": "headers" + }, + "1089": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit" + }, + "1090": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.__constructor" + }, + "1091": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit" + }, + "1092": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "client" + }, + "1093": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.client" + }, + "1094": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.initiateRequest" + }, + "1095": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.initiateRequest" + }, + "1096": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "body" + }, + "1097": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1098": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1099": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.request" + }, + "1100": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.request" + }, + "1101": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1102": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1103": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1104": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.confirm" + }, + "1105": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.confirm" + }, + "1106": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1107": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1108": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1109": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.cancelRequest" + }, + "1110": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.cancelRequest" + }, + "1111": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1112": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1113": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1114": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.addItems" + }, + "1115": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.addItems" + }, + "1116": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1117": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "body" + }, + "1118": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1119": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1120": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.updateOriginalItem" + }, + "1121": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.updateOriginalItem" + }, + "1122": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1123": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "itemId" + }, + "1124": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "body" + }, + "1125": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1126": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1127": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.updateAddedItem" + }, + "1128": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.updateAddedItem" + }, + "1129": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1130": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "actionId" + }, + "1131": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "body" + }, + "1132": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1133": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1134": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.removeAddedItem" + }, + "1135": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "OrderEdit.removeAddedItem" + }, + "1136": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "id" + }, + "1137": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "actionId" + }, + "1138": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "query" + }, + "1139": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", + "qualifiedName": "headers" + }, + "1140": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return" + }, + "1141": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.__constructor" + }, + "1142": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return" + }, + "1143": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "client" + }, + "1144": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.client" + }, + "1145": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.list" + }, + "1146": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.list" + }, + "1147": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1148": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1149": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.retrieve" + }, + "1150": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.retrieve" + }, + "1151": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1152": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1153": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1154": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.initiateRequest" + }, + "1155": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.initiateRequest" + }, + "1156": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1157": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1158": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1159": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.cancel" + }, + "1160": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.cancel" + }, + "1161": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1162": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1163": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1164": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.cancelRequest" + }, + "1165": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.cancelRequest" + }, + "1166": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1167": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1168": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1169": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.addReturnItem" + }, + "1170": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.addReturnItem" + }, + "1171": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1172": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1173": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1174": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1175": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateReturnItem" + }, + "1176": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateReturnItem" + }, + "1177": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1178": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1179": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1180": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1181": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1182": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.removeReturnItem" + }, + "1183": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.removeReturnItem" + }, + "1184": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1185": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1186": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1187": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1188": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.addReturnShipping" + }, + "1189": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.addReturnShipping" + }, + "1190": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1191": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1192": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1193": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1194": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateReturnShipping" + }, + "1195": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateReturnShipping" + }, + "1196": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1197": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1198": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1199": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1200": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1201": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.deleteReturnShipping" + }, + "1202": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.deleteReturnShipping" + }, + "1203": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1204": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1205": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1206": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1207": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateRequest" + }, + "1208": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateRequest" + }, + "1209": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1210": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1211": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1212": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1213": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.confirmRequest" + }, + "1214": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.confirmRequest" + }, + "1215": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1216": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1217": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1218": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1219": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.initiateReceive" + }, + "1220": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.initiateReceive" + }, + "1221": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1222": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1223": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1224": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1225": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.receiveItems" + }, + "1226": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.receiveItems" + }, + "1227": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1228": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1229": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1230": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1231": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateReceiveItem" + }, + "1232": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateReceiveItem" + }, + "1233": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1234": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1235": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1236": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1237": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1238": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.removeReceiveItem" + }, + "1239": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.removeReceiveItem" + }, + "1240": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1241": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1242": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1243": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1244": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.dismissItems" + }, + "1245": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.dismissItems" + }, + "1246": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1247": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1248": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1249": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1250": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateDismissItem" + }, + "1251": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.updateDismissItem" + }, + "1252": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1253": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1254": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1255": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1256": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1257": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.removeDismissItem" + }, + "1258": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.removeDismissItem" + }, + "1259": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1260": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "actionId" + }, + "1261": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1262": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1263": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.confirmReceive" + }, + "1264": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.confirmReceive" + }, + "1265": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1266": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "body" + }, + "1267": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1268": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1269": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.cancelReceive" + }, + "1270": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "Return.cancelReceive" + }, + "1271": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "id" + }, + "1272": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "query" + }, + "1273": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", + "qualifiedName": "headers" + }, + "1274": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim" + }, + "1275": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.__constructor" + }, + "1276": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim" + }, + "1277": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "client" + }, + "1278": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.client" + }, + "1279": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.list" + }, + "1280": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.list" + }, + "1281": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1282": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1283": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.retrieve" + }, + "1284": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.retrieve" + }, + "1285": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1286": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1287": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1288": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.create" + }, + "1289": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.create" + }, + "1290": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1291": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1292": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1293": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.cancel" + }, + "1294": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.cancel" + }, + "1295": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1296": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1297": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1298": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addItems" + }, + "1299": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addItems" + }, + "1300": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1301": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1302": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1303": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1304": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateItem" + }, + "1305": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateItem" + }, + "1306": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1307": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1308": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1309": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1310": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1311": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.removeItem" + }, + "1312": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.removeItem" + }, + "1313": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1314": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1315": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1316": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1317": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addInboundItems" + }, + "1318": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addInboundItems" + }, + "1319": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1320": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1321": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1322": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1323": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateInboundItem" + }, + "1324": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateInboundItem" + }, + "1325": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1326": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1327": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1328": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1329": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1330": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.removeInboundItem" + }, + "1331": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.removeInboundItem" + }, + "1332": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1333": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1334": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1335": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1336": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addInboundShipping" + }, + "1337": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addInboundShipping" + }, + "1338": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1339": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1340": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1341": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1342": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateInboundShipping" + }, + "1343": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateInboundShipping" + }, + "1344": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1345": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1346": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1347": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1348": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1349": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.deleteInboundShipping" + }, + "1350": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.deleteInboundShipping" + }, + "1351": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1352": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1353": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1354": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1355": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addOutboundItems" + }, + "1356": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addOutboundItems" + }, + "1357": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1358": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1359": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1360": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1361": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateOutboundItem" + }, + "1362": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateOutboundItem" + }, + "1363": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1364": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1365": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1366": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1367": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1368": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.removeOutboundItem" + }, + "1369": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.removeOutboundItem" + }, + "1370": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1371": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1372": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1373": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1374": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addOutboundShipping" + }, + "1375": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.addOutboundShipping" + }, + "1376": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1377": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1378": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1379": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1380": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateOutboundShipping" + }, + "1381": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.updateOutboundShipping" + }, + "1382": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1383": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1384": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1385": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1386": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1387": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.deleteOutboundShipping" + }, + "1388": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.deleteOutboundShipping" + }, + "1389": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1390": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "actionId" + }, + "1391": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1392": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1393": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.request" + }, + "1394": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.request" + }, + "1395": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1396": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "body" + }, + "1397": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1398": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1399": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.cancelRequest" + }, + "1400": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "Claim.cancelRequest" + }, + "1401": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "id" + }, + "1402": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "query" + }, + "1403": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", + "qualifiedName": "headers" + }, + "1404": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange" + }, + "1405": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.__constructor" + }, + "1406": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange" + }, + "1407": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "client" + }, + "1408": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.client" + }, + "1409": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.list" + }, + "1410": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.list" + }, + "1411": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1412": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1413": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.retrieve" + }, + "1414": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.retrieve" + }, + "1415": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1416": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1417": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1418": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.create" + }, + "1419": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.create" + }, + "1420": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1421": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1422": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1423": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.cancel" + }, + "1424": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.cancel" + }, + "1425": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1426": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1427": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1428": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addInboundItems" + }, + "1429": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addInboundItems" + }, + "1430": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1431": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1432": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1433": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1434": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateInboundItem" + }, + "1435": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateInboundItem" + }, + "1436": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1437": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1438": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1439": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1440": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1441": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.removeInboundItem" + }, + "1442": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.removeInboundItem" + }, + "1443": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1444": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1445": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1446": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1447": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addInboundShipping" + }, + "1448": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addInboundShipping" + }, + "1449": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1450": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1451": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1452": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1453": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateInboundShipping" + }, + "1454": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateInboundShipping" + }, + "1455": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1456": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1457": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1458": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1459": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1460": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.deleteInboundShipping" + }, + "1461": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.deleteInboundShipping" + }, + "1462": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1463": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1464": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1465": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1466": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addOutboundItems" + }, + "1467": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addOutboundItems" + }, + "1468": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1469": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1470": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1471": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1472": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateOutboundItem" + }, + "1473": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateOutboundItem" + }, + "1474": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1475": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1476": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1477": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1478": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1479": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.removeOutboundItem" + }, + "1480": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.removeOutboundItem" + }, + "1481": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1482": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1483": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1484": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1485": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addOutboundShipping" + }, + "1486": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.addOutboundShipping" + }, + "1487": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1488": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1489": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1490": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1491": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateOutboundShipping" + }, + "1492": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.updateOutboundShipping" + }, + "1493": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1494": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1495": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1496": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1497": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1498": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.deleteOutboundShipping" + }, + "1499": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.deleteOutboundShipping" + }, + "1500": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1501": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "actionId" + }, + "1502": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1503": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1504": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.request" + }, + "1505": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.request" + }, + "1506": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1507": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "body" + }, + "1508": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1509": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1510": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.cancelRequest" + }, + "1511": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "Exchange.cancelRequest" + }, + "1512": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "id" + }, + "1513": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "query" + }, + "1514": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", + "qualifiedName": "headers" + }, + "1515": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate" + }, + "1516": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.__constructor" + }, + "1517": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate" + }, + "1518": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "client" + }, + "1519": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.client" + }, + "1520": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.create" + }, + "1521": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.create" + }, + "1522": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "body" + }, + "1523": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "query" + }, + "1524": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "headers" + }, + "1525": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.update" + }, + "1526": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.update" + }, + "1527": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "id" + }, + "1528": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "body" + }, + "1529": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "query" + }, + "1530": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "headers" + }, + "1531": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.delete" + }, + "1532": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.delete" + }, + "1533": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "id" + }, + "1534": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "headers" + }, + "1535": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.retrieve" + }, + "1536": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.retrieve" + }, + "1537": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "id" + }, + "1538": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "query" + }, + "1539": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "headers" + }, + "1540": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.list" + }, + "1541": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "TaxRate.list" + }, + "1542": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "query" + }, + "1543": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", + "qualifiedName": "headers" + }, + "1544": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion" + }, + "1545": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.__constructor" + }, + "1546": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion" + }, + "1547": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "client" + }, + "1548": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.client" + }, + "1549": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.create" + }, + "1550": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.create" + }, + "1551": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "body" + }, + "1552": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "query" + }, + "1553": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "headers" + }, + "1554": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.delete" + }, + "1555": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.delete" + }, + "1556": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "id" + }, + "1557": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "headers" + }, + "1558": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.retrieve" + }, + "1559": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.retrieve" + }, + "1560": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "id" + }, + "1561": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "query" + }, + "1562": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "headers" + }, + "1563": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.list" + }, + "1564": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "TaxRegion.list" + }, + "1565": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "query" + }, + "1566": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", + "qualifiedName": "headers" + }, + "1567": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store" + }, + "1568": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.__constructor" + }, + "1569": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store" + }, + "1570": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "client" + }, + "1571": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.client" + }, + "1572": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.retrieve" + }, + "1573": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.retrieve" + }, + "1574": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "id" + }, + "1575": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "query" + }, + "1576": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "headers" + }, + "1577": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.list" + }, + "1578": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.list" + }, + "1579": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "query" + }, + "1580": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "headers" + }, + "1581": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.update" + }, + "1582": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "Store.update" + }, + "1583": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "id" + }, + "1584": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "body" + }, + "1585": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "query" + }, + "1586": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", + "qualifiedName": "headers" + }, + "1587": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag" + }, + "1588": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.__constructor" + }, + "1589": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag" + }, + "1590": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "client" + }, + "1591": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.client" + }, + "1592": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.create" + }, + "1593": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.create" + }, + "1594": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "body" + }, + "1595": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "query" + }, + "1596": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "headers" + }, + "1597": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.update" + }, + "1598": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.update" + }, + "1599": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "id" + }, + "1600": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "body" + }, + "1601": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "query" + }, + "1602": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "headers" + }, + "1603": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.list" + }, + "1604": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.list" + }, + "1605": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "query" + }, + "1606": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "headers" + }, + "1607": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.retrieve" + }, + "1608": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.retrieve" + }, + "1609": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "id" + }, + "1610": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "query" + }, + "1611": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "headers" + }, + "1612": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.delete" + }, + "1613": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "ProductTag.delete" + }, + "1614": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "id" + }, + "1615": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", + "qualifiedName": "headers" + }, + "1616": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User" + }, + "1617": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.__constructor" + }, + "1618": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User" + }, + "1619": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "client" + }, + "1620": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.client" + }, + "1621": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.create" + }, + "1622": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.create" + }, + "1623": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "body" + }, + "1624": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "query" + }, + "1625": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "headers" + }, + "1626": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.update" + }, + "1627": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.update" + }, + "1628": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "id" + }, + "1629": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "body" + }, + "1630": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "query" + }, + "1631": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "headers" + }, + "1632": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.list" + }, + "1633": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.list" + }, + "1634": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "queryParams" + }, + "1635": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "headers" + }, + "1636": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.retrieve" + }, + "1637": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.retrieve" + }, + "1638": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "id" + }, + "1639": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "query" + }, + "1640": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "headers" + }, + "1641": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.delete" + }, + "1642": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.delete" + }, + "1643": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "id" + }, + "1644": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "headers" + }, + "1645": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.me" + }, + "1646": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "User.me" + }, + "1647": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "query" + }, + "1648": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", + "qualifiedName": "headers" + }, + "1649": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency" + }, + "1650": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency.__constructor" + }, + "1651": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency" + }, + "1652": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "client" + }, + "1653": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency.client" + }, + "1654": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency.list" + }, + "1655": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency.list" + }, + "1656": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "query" + }, + "1657": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "headers" + }, + "1658": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency.retrieve" + }, + "1659": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "Currency.retrieve" + }, + "1660": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "code" + }, + "1661": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "query" + }, + "1662": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", + "qualifiedName": "headers" + }, + "1663": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment" + }, + "1664": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.__constructor" + }, + "1665": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment" + }, + "1666": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "client" + }, + "1667": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.client" + }, + "1668": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.list" + }, + "1669": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.list" + }, + "1670": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "query" + }, + "1671": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "headers" + }, + "1672": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.listPaymentProviders" + }, + "1673": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.listPaymentProviders" + }, + "1674": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "query" + }, + "1675": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "headers" + }, + "1676": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.retrieve" + }, + "1677": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.retrieve" + }, + "1678": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "id" + }, + "1679": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "query" + }, + "1680": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "headers" + }, + "1681": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.capture" + }, + "1682": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.capture" + }, + "1683": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "id" + }, + "1684": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "body" + }, + "1685": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "query" + }, + "1686": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "headers" + }, + "1687": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.refund" + }, + "1688": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "Payment.refund" + }, + "1689": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "id" + }, + "1690": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "body" + }, + "1691": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "query" + }, + "1692": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", + "qualifiedName": "headers" + }, + "1693": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "ProductVariant" + }, + "1694": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "ProductVariant.__constructor" + }, + "1695": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "ProductVariant" + }, + "1696": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "client" + }, + "1697": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "ProductVariant.client" + }, + "1698": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "ProductVariant.list" + }, + "1699": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "ProductVariant.list" + }, + "1700": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "queryParams" + }, + "1701": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", + "qualifiedName": "headers" + }, + "1702": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "RefundReason" + }, + "1703": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "RefundReason.__constructor" + }, + "1704": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "RefundReason" + }, + "1705": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "client" + }, + "1706": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "RefundReason.client" + }, + "1707": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "RefundReason.list" + }, + "1708": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "RefundReason.list" + }, + "1709": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "query" + }, + "1710": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", + "qualifiedName": "headers" + }, + "1711": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection" + }, + "1712": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.__constructor" + }, + "1713": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection" + }, + "1714": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "client" + }, + "1715": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.client" + }, + "1716": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.list" + }, + "1717": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.list" + }, + "1718": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "query" + }, + "1719": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "headers" + }, + "1720": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.retrieve" + }, + "1721": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.retrieve" + }, + "1722": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "id" + }, + "1723": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "query" + }, + "1724": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "headers" + }, + "1725": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.create" + }, + "1726": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.create" + }, + "1727": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "body" + }, + "1728": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "query" + }, + "1729": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "headers" + }, + "1730": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.delete" + }, + "1731": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.delete" + }, + "1732": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "id" + }, + "1733": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "headers" + }, + "1734": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.markAsPaid" + }, + "1735": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "PaymentCollection.markAsPaid" + }, + "1736": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "id" + }, + "1737": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "body" + }, + "1738": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "query" + }, + "1739": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", + "qualifiedName": "headers" + }, + "1740": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey" + }, + "1741": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.__constructor" + }, + "1742": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey" + }, + "1743": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "client" + }, + "1744": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.client" + }, + "1745": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.list" + }, + "1746": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.list" + }, + "1747": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "queryParams" + }, + "1748": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1749": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.create" + }, + "1750": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.create" + }, + "1751": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "body" + }, + "1752": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "query" + }, + "1753": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1754": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.revoke" + }, + "1755": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.revoke" + }, + "1756": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "id" + }, + "1757": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1758": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.retrieve" + }, + "1759": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.retrieve" + }, + "1760": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "id" + }, + "1761": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1762": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.update" + }, + "1763": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.update" + }, + "1764": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "id" + }, + "1765": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "body" + }, + "1766": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "query" + }, + "1767": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1768": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.delete" + }, + "1769": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.delete" + }, + "1770": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "id" + }, + "1771": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1772": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.batchSalesChannels" + }, + "1773": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "ApiKey.batchSalesChannels" + }, + "1774": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "id" + }, + "1775": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "body" + }, + "1776": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", + "qualifiedName": "headers" + }, + "1777": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution" + }, + "1778": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution.__constructor" + }, + "1779": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution" + }, + "1780": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "client" + }, + "1781": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution.client" + }, + "1782": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution.list" + }, + "1783": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution.list" + }, + "1784": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "queryParams" + }, + "1785": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "headers" + }, + "1786": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution.retrieve" + }, + "1787": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "WorkflowExecution.retrieve" + }, + "1788": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "id" + }, + "1789": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", + "qualifiedName": "headers" + }, + "1790": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation" + }, + "1791": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.__constructor" + }, + "1792": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation" + }, + "1793": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "client" + }, + "1794": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.client" + }, + "1795": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.retrieve" + }, + "1796": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.retrieve" + }, + "1797": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "id" + }, + "1798": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "query" + }, + "1799": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "headers" + }, + "1800": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.list" + }, + "1801": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.list" + }, + "1802": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "query" + }, + "1803": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "headers" + }, + "1804": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.create" + }, + "1805": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.create" + }, + "1806": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "body" + }, + "1807": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "query" + }, + "1808": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "headers" + }, + "1809": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.update" + }, + "1810": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.update" + }, + "1811": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "id" + }, + "1812": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "body" + }, + "1813": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "query" + }, + "1814": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "headers" + }, + "1815": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.delete" + }, + "1816": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "Reservation.delete" + }, + "1817": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "id" + }, + "1818": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", + "qualifiedName": "headers" + }, + "1819": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "1820": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.__constructor" + }, + "1821": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "1822": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "client" + }, + "1823": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.client" + }, + "1824": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.retrieve" + }, + "1825": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.retrieve" + }, + "1826": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "id" + }, + "1827": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "query" + }, + "1828": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "headers" + }, + "1829": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.list" + }, + "1830": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.list" + }, + "1831": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "query" + }, + "1832": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "headers" + }, + "1833": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.create" + }, + "1834": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.create" + }, + "1835": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "body" + }, + "1836": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "query" + }, + "1837": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "headers" + }, + "1838": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.update" + }, + "1839": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.update" + }, + "1840": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "id" + }, + "1841": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "body" + }, + "1842": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "query" + }, + "1843": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "headers" + }, + "1844": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.delete" + }, + "1845": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.delete" + }, + "1846": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "id" + }, + "1847": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "headers" + }, + "1848": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.batchCustomers" + }, + "1849": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "CustomerGroup.batchCustomers" + }, + "1850": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "id" + }, + "1851": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "body" + }, + "1852": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", + "qualifiedName": "headers" + }, + "1853": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion" + }, + "1854": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.__constructor" + }, + "1855": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion" + }, + "1856": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "client" + }, + "1857": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.client" + }, + "1858": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.retrieve" + }, + "1859": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.retrieve" + }, + "1860": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1861": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "query" + }, + "1862": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1863": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.list" + }, + "1864": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.list" + }, + "1865": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "query" + }, + "1866": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1867": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.create" + }, + "1868": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.create" + }, + "1869": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "payload" + }, + "1870": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1871": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.update" + }, + "1872": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.update" + }, + "1873": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1874": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "payload" + }, + "1875": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1876": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.delete" + }, + "1877": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.delete" + }, + "1878": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1879": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1880": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.addRules" + }, + "1881": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.addRules" + }, + "1882": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1883": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleType" + }, + "1884": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "payload" + }, + "1885": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1886": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.updateRules" + }, + "1887": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.updateRules" + }, + "1888": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1889": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleType" + }, + "1890": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "payload" + }, + "1891": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1892": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.removeRules" + }, + "1893": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.removeRules" + }, + "1894": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1895": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleType" + }, + "1896": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "payload" + }, + "1897": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1898": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.listRules" + }, + "1899": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.listRules" + }, + "1900": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "id" + }, + "1901": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleType" + }, + "1902": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "query" + }, + "1903": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1904": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.listRuleAttributes" + }, + "1905": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.listRuleAttributes" + }, + "1906": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleType" + }, + "1907": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "promotionType" + }, + "1908": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1909": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.listRuleValues" + }, + "1910": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "Promotion.listRuleValues" + }, + "1911": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleType" + }, + "1912": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "ruleValue" + }, + "1913": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "query" + }, + "1914": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", + "qualifiedName": "headers" + }, + "1915": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign" + }, + "1916": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.__constructor" + }, + "1917": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign" + }, + "1918": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "client" + }, + "1919": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.client" + }, + "1920": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.retrieve" + }, + "1921": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.retrieve" + }, + "1922": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "id" + }, + "1923": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "query" + }, + "1924": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "headers" + }, + "1925": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.list" + }, + "1926": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.list" + }, + "1927": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "query" + }, + "1928": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "headers" + }, + "1929": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.create" + }, + "1930": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.create" + }, + "1931": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "payload" + }, + "1932": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "headers" + }, + "1933": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.update" + }, + "1934": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.update" + }, + "1935": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "id" + }, + "1936": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "payload" + }, + "1937": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "headers" + }, + "1938": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.delete" + }, + "1939": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.delete" + }, + "1940": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "id" + }, + "1941": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "headers" + }, + "1942": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.batchPromotions" + }, + "1943": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "Campaign.batchPromotions" + }, + "1944": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "id" + }, + "1945": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "payload" + }, + "1946": { + "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", + "qualifiedName": "headers" + }, + "1947": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client" + }, + "1948": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.__constructor" + }, + "1949": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client" + }, + "1950": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "config" + }, + "1951": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.fetch_" + }, + "1952": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.config" + }, + "1953": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.logger" + }, + "1954": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.DEFAULT_JWT_STORAGE_KEY" + }, + "1955": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.token" + }, + "1956": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.fetch" + }, + "1957": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.fetch" + }, + "1958": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "T" + }, + "1959": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "input" + }, + "1960": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "init" + }, + "1961": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.fetchStream" + }, + "1962": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.fetchStream" + }, + "1963": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "input" + }, + "1964": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "init" + }, + "1965": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.setToken" + }, + "1966": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.setToken" + }, + "1967": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "token" + }, + "1968": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.clearToken" + }, + "1969": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.clearToken" + }, + "1970": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.clearToken_" + }, + "1971": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.clearToken_" + }, + "1972": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.initClient" + }, + "1973": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.initClient" + }, + "1974": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getApiKeyHeader_" + }, + "1975": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getApiKeyHeader_" + }, + "1976": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "1977": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__type" + }, + "1978": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__type.Authorization" + }, + "1979": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getPublishableKeyHeader_" + }, + "1980": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getPublishableKeyHeader_" + }, + "1981": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "1982": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__type" + }, + "1983": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__type.x-publishable-api-key" + }, + "1984": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getJwtHeader_" + }, + "1985": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getJwtHeader_" + }, + "1986": { + "sourceFileName": "", + "qualifiedName": "__type" + }, + "1987": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__type" + }, + "1988": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__type.Authorization" + }, + "1989": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.setToken_" + }, + "1990": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.setToken_" + }, + "1991": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "token" + }, + "1992": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getToken_" + }, + "1993": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getToken_" + }, + "1994": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getTokenStorageInfo_" + }, + "1995": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "Client.getTokenStorageInfo_" + }, + "1996": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__object" + }, + "1997": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__object.storageMethod" + }, + "1998": { + "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", + "qualifiedName": "__object.storageKey" + }, + "1999": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ClientHeaders" + }, + "2000": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2001": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.tags" + }, + "2002": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "Config" + }, + "2003": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2004": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.baseUrl" + }, + "2005": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.globalHeaders" + }, + "2006": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.publishableKey" + }, + "2007": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.apiKey" + }, + "2008": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.auth" + }, + "2009": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2010": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.type" + }, + "2011": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.jwtTokenStorageKey" + }, + "2012": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.jwtTokenStorageMethod" + }, + "2013": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.logger" + }, + "2014": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.debug" + }, + "2015": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ClientFetch" + }, + "2016": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2017": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2018": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "input" + }, + "2019": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "init" + }, + "2020": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "Logger" + }, + "2021": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2022": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.error" + }, + "2023": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2024": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2025": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "messages" + }, + "2026": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.warn" + }, + "2027": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2028": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2029": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "messages" + }, + "2030": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.info" + }, + "2031": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2032": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2033": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "messages" + }, + "2034": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.debug" + }, + "2035": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2036": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2037": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "messages" + }, + "2038": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "FetchArgs" + }, + "2039": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2040": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.query" + }, + "2041": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.headers" + }, + "2042": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type.body" + }, + "2043": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "FetchStreamResponse" + }, + "2044": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "FetchStreamResponse.stream" + }, + "2045": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "FetchStreamResponse.abort" + }, + "2046": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2047": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "__type" + }, + "2048": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "FetchInput" + }, + "2049": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ServerSentEventMessage" + }, + "2050": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ServerSentEventMessage.comment" + }, + "2051": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ServerSentEventMessage.event" + }, + "2052": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ServerSentEventMessage.data" + }, + "2053": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ServerSentEventMessage.id" + }, + "2054": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "ServerSentEventMessage.retry" + }, + "2055": { + "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", + "qualifiedName": "FetchParams" + } + }, + "files": { + "entries": { + "1": "../../../../packages/core/js-sdk/src/admin/index.ts", + "2": "../../../../packages/core/js-sdk/src/auth/index.ts", + "3": "../../../../packages/core/js-sdk/src/store/index.ts" + }, + "reflections": { + "1": 1, + "2": 47, + "3": 91 + } + } +} diff --git a/www/utils/packages/typedoc-generate-references/src/constants/base-section-options.ts b/www/utils/packages/typedoc-generate-references/src/constants/base-section-options.ts index 727cf7133b..2cd93af48d 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/base-section-options.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/base-section-options.ts @@ -14,6 +14,7 @@ const baseSectionsOptions: Sections = { member_signature_returns: false, title_reflectionPath: false, member_declaration_children: false, + member_force_title: false, } export default baseSectionsOptions diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/js-sdk.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/js-sdk.ts index 057669833e..b77f2a6376 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/js-sdk.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/js-sdk.ts @@ -59,6 +59,12 @@ const jsSdkOptions: FormattingOptionsType = { }, reflectionDescription: "This documentation provides a reference to the `sdk.admin.{{alias}}` set of methods used to send requests to Medusa's Admin API routes.", + sections: { + ...baseSectionsOptions, + member_declaration_title: false, + member_declaration_children: true, + member_force_title: true, + }, }, "^js_sdk/auth/classes/.*Auth": { frontmatterData: { diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts index e1a666a569..c7da87bdd7 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts @@ -74,6 +74,7 @@ import workflowInputHelper from "./resources/helpers/workflow-input" import workflowOutputHelper from "./resources/helpers/workflow-output" import workflowDiagramHelper from "./resources/helpers/workflow-diagram" import workflowHooksHelper from "./resources/helpers/workflow-hooks" +import ifMemberShowTitleHelper from "./resources/helpers/if-member-show-title" import { MarkdownTheme } from "./theme" const TEMPLATE_PATH = path.join(__dirname, "resources", "templates") @@ -176,4 +177,5 @@ export function registerHelpers(theme: MarkdownTheme) { workflowOutputHelper(theme) workflowDiagramHelper(theme) workflowHooksHelper(theme) + ifMemberShowTitleHelper(theme) } diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-member-show-title.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-member-show-title.ts new file mode 100644 index 0000000000..55b326da2d --- /dev/null +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-member-show-title.ts @@ -0,0 +1,16 @@ +import * as Handlebars from "handlebars" +import { DeclarationReflection } from "typedoc" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "ifMemberShowTitle", + function (this: DeclarationReflection, options: Handlebars.HelperOptions) { + return !this.hasOwnDocument || + (Handlebars.helpers.sectionEnabled("member_force_title") && + theme.location !== this.url) + ? options.fn(this) + : options.inverse(this) + } + ) +} diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs index 7462341f74..15b274a7ef 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs @@ -1,4 +1,4 @@ -{{#unless hasOwnDocument}} +{{#ifMemberShowTitle}} {{#if name}} @@ -8,7 +8,7 @@ {{/if}} -{{/unless}} +{{/ifMemberShowTitle}} {{#if signatures}} @@ -64,7 +64,7 @@ {{/if}} -{{#unless hasOwnDocument}} +{{#ifMemberShowTitle}} {{#if name}} @@ -72,14 +72,14 @@ {{/if}} -{{/unless}} +{{/ifMemberShowTitle}} {{#ifShowSeparatorForTitleLevel}} {{#unless @last}} -{{#unless hasOwnDocument}} +{{#ifMemberShowTitle}} {{#unless removeSeparator}} ___ {{/unless}} -{{/unless}} +{{/ifMemberShowTitle}} {{/unless}} {{/ifShowSeparatorForTitleLevel}} \ No newline at end of file diff --git a/www/utils/packages/types/lib/index.d.ts b/www/utils/packages/types/lib/index.d.ts index 58c9695394..87599af861 100644 --- a/www/utils/packages/types/lib/index.d.ts +++ b/www/utils/packages/types/lib/index.d.ts @@ -30,6 +30,7 @@ export type SectionKey = | "members_group_categories" | "members_categories" | "member_returns" + | "member_force_title" | "title_reflectionPath" | "reflection_comment" | "reflection_typeParameters"